Packages

c

firrtl.transforms

ManipulateNamesAllowlistResultAnnotation

case class ManipulateNamesAllowlistResultAnnotation[A <: ManipulateNames[_]](targets: Seq[Seq[Target]], transform: Dependency[A], oldTargets: Seq[Seq[Target]]) extends MultiTargetAnnotation with Product with Serializable

Records the result of name changes for any targets included in a ManipulateNamesAllowlistAnnotation

If targets are later removed, then a target and old target will be removed from this annotation. If all targets are removed, then this annotation will be deleted.

targets

the new targets

transform

the transform that performed this rename

oldTargets

the old targets

Source
ManipulateNames.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ManipulateNamesAllowlistResultAnnotation
  2. Serializable
  3. Serializable
  4. MultiTargetAnnotation
  5. Annotation
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ManipulateNamesAllowlistResultAnnotation(targets: Seq[Seq[Target]], transform: Dependency[A], oldTargets: Seq[Seq[Target]])

    targets

    the new targets

    transform

    the transform that performed this rename

    oldTargets

    the old targets

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def duplicate(a: Seq[Seq[Target]]): ManipulateNamesAllowlistResultAnnotation[A]

    Create another instance of this Annotation

    Create another instance of this Annotation

    The inner Seqs correspond to the renames of the inner Seqs of targets

    Definition Classes
    ManipulateNamesAllowlistResultAnnotationMultiTargetAnnotation
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def flat(): AnnotationSeq

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) After flat, this Annotation will be flat to the AnnotationSeq in the below form Seq(Seq(TargetA1), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA1), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA2), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA2), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA3), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA3), Seq(TargetB2), Seq(TargetC))

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) After flat, this Annotation will be flat to the AnnotationSeq in the below form Seq(Seq(TargetA1), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA1), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA2), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA2), Seq(TargetB2), Seq(TargetC)) Seq(Seq(TargetA3), Seq(TargetB1), Seq(TargetC)); Seq(Seq(TargetA3), Seq(TargetB2), Seq(TargetC))

    Definition Classes
    MultiTargetAnnotation
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getTargets: Seq[Target]

    Returns all Target members in this annotation

    Returns all Target members in this annotation

    Definition Classes
    Annotation
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. val oldTargets: Seq[Seq[Target]]
  17. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. val targets: Seq[Seq[Target]]

    Contains a nested sequence of Target

    Contains a nested sequence of Target

    Each inner Seq should contain a single element. For example:

    def targets = Seq(Seq(foo), Seq(bar))
    Definition Classes
    ManipulateNamesAllowlistResultAnnotationMultiTargetAnnotation
  20. def toRenameMap: RenameMap

    Return RenameMap from old targets to new targets

  21. val transform: Dependency[A]
  22. def update(renames: RenameMap): Seq[Annotation]

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) in the update, this Annotation is still one annotation, but the contents are renamed in the below form Seq(Seq(TargetA1, TargetA2, TargetA3), Seq(TargetB1, TargetB2), Seq(TargetC))

    Assume RenameMap is Map(TargetA -> Seq(TargetA1, TargetA2, TargetA3), TargetB -> Seq(TargetB1, TargetB2)) in the update, this Annotation is still one annotation, but the contents are renamed in the below form Seq(Seq(TargetA1, TargetA2, TargetA3), Seq(TargetB1, TargetB2), Seq(TargetC))

    Definition Classes
    ManipulateNamesAllowlistResultAnnotationMultiTargetAnnotationAnnotation
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from MultiTargetAnnotation

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped