Package org.immutables.value.processor.meta

Class IncludeMirror

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

  • Field Details

  • Constructor Details

    • IncludeMirror

      private IncludeMirror(TypeElement defaultAnnotationElement)

    • IncludeMirror

      private IncludeMirror(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<IncludeMirror> find(Element element)
      Finds first annotation of this type on the element.
      Parameters:
      element - annotated element
      Returns:
      optional IncludeMirror, present if this annotation found

    • find

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

    • fromAll

      public static com.google.common.collect.ImmutableList<IncludeMirror> 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 IncludeMirrors

    • from

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

    • from

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

    • valueName

      public String[] valueName()
      Returns:
      type name for value of attribute value

    • valueMirror

      public TypeMirror[] valueMirror()
      Returns:
      type mirror for value of attribute value

    • value

      @Deprecated public Class<?>[] value()
      Deprecated.
      Always throws UnsupportedOperationException. Use valueMirror() or valueName.

    • getAnnotationMirror

      public AnnotationMirror getAnnotationMirror()
      Returns:
      underlying annotation mirror

    • annotationType

      public Class<? extends Annotation> annotationType()
      Specified by:
      annotationType in interface Annotation
      Returns:
      Include.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