Package org.immutables.value.processor.meta

Class ImmutableMirror

  • All Implemented Interfaces:
    java.lang.annotation.Annotation
    public class ImmutableMirror
extends java.lang.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:
    find(Iterable), from(AnnotationMirror)

    • Field Detail

      • MIRROR_QUALIFIED_NAME

        public static final java.lang.String MIRROR_QUALIFIED_NAME
        See Also:
        Constant Field Values

      • annotationMirror

        private final javax.lang.model.element.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 Detail

      • ImmutableMirror

        private ImmutableMirror​(javax.lang.model.element.TypeElement defaultAnnotationElement)

      • ImmutableMirror

        private ImmutableMirror​(javax.lang.model.element.AnnotationMirror annotationMirror)

    • Method Detail

      • mirrorQualifiedName

        public static java.lang.String mirrorQualifiedName()

      • qualifiedName

        public static java.lang.String qualifiedName()

      • simpleName

        public static java.lang.String simpleName()

      • isPresent

        public static boolean isPresent​(javax.lang.model.element.Element annotatedElement)

      • find

        public static com.google.common.base.Optional<ImmutableMirror> find​(javax.lang.model.element.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​(java.lang.Iterable<? extends javax.lang.model.element.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​(java.lang.Iterable<? extends javax.lang.model.element.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​(javax.lang.model.element.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​(javax.lang.model.element.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 javax.lang.model.element.AnnotationMirror getAnnotationMirror()
        Returns:
        underlying annotation mirror

      • annotationType

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

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.lang.annotation.Annotation
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Specified by:
        equals in interface java.lang.annotation.Annotation
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface java.lang.annotation.Annotation
        Overrides:
        toString in class java.lang.Object