Scala Compiler 2.13.16 - scala.tools.nsc.doc.model.diagram.DiagramDirectiveParser.AnnotationDiagramFilter
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.doc.model.diagram.DiagramDirectiveParser.AnnotationDiagramFilter

Scala Compiler2.13.16 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package doc
  Definition Classes
    nsc
-  package model
  Definition Classes
    doc
-  package diagram
  Definition Classes
    model
-  trait DiagramDirectiveParser extends AnyRef

  This trait takes care of parsing @{inheritance, content}Diagram annotations

  This trait takes care of parsing @{inheritance, content}Diagram annotations

  Definition Classes
    diagram
- AnnotationDiagramFilter
- DiagramFilter
- FullDiagram
- NoDiagramAtAll

c

scala.tools.nsc.doc.model.diagram.DiagramDirectiveParser

# AnnotationDiagramFilter

###

#### case class AnnotationDiagramFilter(hideDiagram: Boolean, hideIncomingImplicits: Boolean, hideOutgoingImplicits: Boolean, hideSuperclasses: Boolean, hideSubclasses: Boolean, hideInheritedNodes: Boolean, hideNodesFilter: List[Pattern], hideEdgesFilter: List[(Pattern, Pattern)]) extends (DiagramDirectiveParser.this)#DiagramFilter with Product with Serializable

The AnnotationDiagramFilter trait directs the diagram engine according to an annotation TODO: Should document the annotation, for now see parseDiagramAnnotation in ModelFactory.scala

Source
  DiagramDirectiveParser.scala

Linear Supertypes
java.io.Serializable, Product, Equals, (DiagramDirectiveParser.this)#DiagramFilter, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AnnotationDiagramFilter
2. Serializable
3. Product
4. Equals
5. DiagramFilter
6. AnyRef
7. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new AnnotationDiagramFilter(hideDiagram: Boolean, hideIncomingImplicits: Boolean, hideOutgoingImplicits: Boolean, hideSuperclasses: Boolean, hideSubclasses: Boolean, hideInheritedNodes: Boolean, hideNodesFilter: List[Pattern], hideEdgesFilter: List[(Pattern, Pattern)])

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toany2stringadd[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): ((DiagramDirectiveParser.this)#AnnotationDiagramFilter, B)
   Implicit
     This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toArrowAssoc[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: ((DiagramDirectiveParser.this)#AnnotationDiagramFilter) => Boolean, msg: => Any): (DiagramDirectiveParser.this)#AnnotationDiagramFilter
   Implicit
     This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toEnsuring[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: ((DiagramDirectiveParser.this)#AnnotationDiagramFilter) => Boolean): (DiagramDirectiveParser.this)#AnnotationDiagramFilter
   Implicit
     This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toEnsuring[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): (DiagramDirectiveParser.this)#AnnotationDiagramFilter
    Implicit
      This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toEnsuring[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): (DiagramDirectiveParser.this)#AnnotationDiagramFilter
    Implicit
      This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toEnsuring[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
14.  final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
15.  val hideDiagram: Boolean

    A flag to hide the diagram completely

    A flag to hide the diagram completely

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
16.  def hideEdge(clazz1: Node, clazz2: Node): Boolean

    Hide an edge from the diagram

    Hide an edge from the diagram

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
    Annotations
      @nowarn()
17.  val hideEdgesFilter: List[(Pattern, Pattern)]
18.  val hideIncomingImplicits: Boolean

    Hide incoming implicit conversions (for type hierarchy diagrams)

    Hide incoming implicit conversions (for type hierarchy diagrams)

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
19.  val hideInheritedNodes: Boolean

    Show related classes from other objects/traits/packages (for content diagrams)

    Show related classes from other objects/traits/packages (for content diagrams)

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
20.  def hideNode(clazz: Node): Boolean

    Hide a node from the diagram

    Hide a node from the diagram

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
    Annotations
      @nowarn()
21.  val hideNodesFilter: List[Pattern]
22.  val hideOutgoingImplicits: Boolean

    Hide outgoing implicit conversions (for type hierarchy diagrams)

    Hide outgoing implicit conversions (for type hierarchy diagrams)

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
23.  val hideSubclasses: Boolean

    Hide subclasses (for type hierarchy diagrams)

    Hide subclasses (for type hierarchy diagrams)

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
24.  val hideSuperclasses: Boolean

    Hide superclasses (for type hierarchy diagrams)

    Hide superclasses (for type hierarchy diagrams)

    Definition Classes
      AnnotationDiagramFilter → DiagramFilter
25.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
26.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
27.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
28.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
29.  def productElementNames: Iterator[String]
    Definition Classes
      Product
30.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
31.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
32.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
33.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toStringFormat[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): ((DiagramDirectiveParser.this)#AnnotationDiagramFilter, B)
   Implicit
     This member is added by an implicit conversion from (DiagramDirectiveParser.this)#AnnotationDiagramFilter toArrowAssoc[(DiagramDirectiveParser.this)#AnnotationDiagramFilter] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from java.io.Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from (DiagramDirectiveParser.this)#DiagramFilter

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from(DiagramDirectiveParser.this)#AnnotationDiagramFilter to any2stringadd[(DiagramDirectiveParser.this)#AnnotationDiagramFilter]

### Inherited by implicit conversion StringFormat from(DiagramDirectiveParser.this)#AnnotationDiagramFilter to StringFormat[(DiagramDirectiveParser.this)#AnnotationDiagramFilter]

### Inherited by implicit conversion Ensuring from(DiagramDirectiveParser.this)#AnnotationDiagramFilter to Ensuring[(DiagramDirectiveParser.this)#AnnotationDiagramFilter]

### Inherited by implicit conversion ArrowAssoc from(DiagramDirectiveParser.this)#AnnotationDiagramFilter to ArrowAssoc[(DiagramDirectiveParser.this)#AnnotationDiagramFilter]

### Ungrouped