Package org.immutables.value.processor.meta

Class ImmutableMirror

java.lang.Object
org.immutables.value.processor.meta.ImmutableMirror
All Implemented Interfaces:
Annotation
public class ImmutableMirror extends Object implements ValueMirrors.Immutable
ImmutableMirror used to parse data of AnnotationMirror for original annotation org.immutables.value.Value.Immutable during annotation processing. Interface is being described using ValueMirrors.Immutable annotation, which should be structurally compatible to the annotation being modelled.
See Also:

  • Field Details

    • QUALIFIED_NAME

      public static final String QUALIFIED_NAME
      See Also:

    • MIRROR_QUALIFIED_NAME

      public static final String MIRROR_QUALIFIED_NAME
      See Also:

    • annotationMirror

      private final AnnotationMirror annotationMirror

    • singleton

      private final boolean singleton

    • intern

      private final boolean intern

    • copy

      private final boolean copy

    • prehash

      private final boolean prehash

    • lazyhash

      private final boolean lazyhash

    • builder

      private final boolean builder

  • Constructor Details

    • ImmutableMirror

      private ImmutableMirror(TypeElement defaultAnnotationElement)

    • ImmutableMirror

      private ImmutableMirror(AnnotationMirror annotationMirror)

  • Method Details

    • mirrorQualifiedName

      public static String mirrorQualifiedName()

    • qualifiedName

      public static String qualifiedName()

    • simpleName

      public static String simpleName()

    • isPresent

      public static boolean isPresent(Element annotatedElement)

    • find

      public static com.google.common.base.Optional<ImmutableMirror> find(Element element)
      Finds first annotation of this type on the element.
      Parameters:
      element - annotated element
      Returns:
      optional ImmutableMirror, present if this annotation found

    • find

      public static com.google.common.base.Optional<ImmutableMirror> find(Iterable<? extends AnnotationMirror> mirrors)
      Finds first annotation of this type in an iterable of annotation mirrors.
      Parameters:
      mirrors - annotation mirrors
      Returns:
      optional ImmutableMirror, present if this annotation found

    • fromAll

      public static com.google.common.collect.ImmutableList<ImmutableMirror> fromAll(Iterable<? extends AnnotationMirror> mirrors)
      Converts iterable of annotation mirrors where all annotation are of this type. Otherwise it fails
      Parameters:
      mirrors - of this annotation type.
      Returns:
      list of converted ImmutableMirrors

    • from

      public static ImmutableMirror from(TypeElement element)
      Creates mirror with default values using annotation element (i.e. declaration, not usage).
      Parameters:
      element - annotation type element
      Returns:
      ImmutableMirror

    • from

      public static com.google.common.base.Optional<ImmutableMirror> from(AnnotationMirror mirror)
      Tries to convert annotation mirror to this annotation type.
      Parameters:
      mirror - annotation mirror
      Returns:
      optional ImmutableMirror, present if mirror matched this annotation type

    • singleton

      public boolean singleton()
      Returns:
      value of attribute singleton

    • intern

      public boolean intern()
      Returns:
      value of attribute intern

    • copy

      public boolean copy()
      Returns:
      value of attribute copy

    • prehash

      public boolean prehash()
      Returns:
      value of attribute prehash

    • lazyhash

      public boolean lazyhash()
      Returns:
      value of attribute lazyhash

    • builder

      public boolean builder()
      Returns:
      value of attribute builder

    • getAnnotationMirror

      public AnnotationMirror getAnnotationMirror()
      Returns:
      underlying annotation mirror

    • annotationType

      public Class<? extends Annotation> annotationType()
      Specified by:
      annotationType in interface Annotation
      Returns:
      Immutable.class

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Annotation
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object other)
      Specified by:
      equals in interface Annotation
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Specified by:
      toString in interface Annotation
      Overrides:
      toString in class Object