Package org.immutables.value.processor.encode

Class NamingMirror

  • All Implemented Interfaces:
    java.lang.annotation.Annotation
    public class NamingMirror
extends java.lang.Object
implements Mirrors.Naming
    NamingMirror used to parse data of AnnotationMirror for original annotation org.immutables.encode.Encoding.Naming during annotation processing. Interface is being described using Mirrors.Naming annotation, which should be structurally compatible to the annotation being modelled.
    See Also:
    find(Iterable), from(AnnotationMirror)

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private NamingMirror​(javax.lang.model.element.AnnotationMirror annotationMirror)  
      private NamingMirror​(javax.lang.model.element.TypeElement defaultAnnotationElement)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Class<? extends java.lang.annotation.Annotation> annotationType()  
      boolean depluralize()  
      boolean equals​(java.lang.Object other)  
      static com.google.common.base.Optional<NamingMirror> find​(java.lang.Iterable<? extends javax.lang.model.element.AnnotationMirror> mirrors)
      Finds first annotation of this type in an iterable of annotation mirrors.
      static com.google.common.base.Optional<NamingMirror> find​(javax.lang.model.element.Element element)
      Finds first annotation of this type on the element.
      static com.google.common.base.Optional<NamingMirror> from​(javax.lang.model.element.AnnotationMirror mirror)
      Tries to convert annotation mirror to this annotation type.
      static NamingMirror from​(javax.lang.model.element.TypeElement element)
      Creates mirror with default values using annotation element (i.e.
      static com.google.common.collect.ImmutableList<NamingMirror> fromAll​(java.lang.Iterable<? extends javax.lang.model.element.AnnotationMirror> mirrors)
      Converts iterable of annotation mirrors where all annotation are of this type.
      javax.lang.model.element.AnnotationMirror getAnnotationMirror()  
      int hashCode()  
      static boolean isPresent​(javax.lang.model.element.Element annotatedElement)  
      static java.lang.String mirrorQualifiedName()  
      static java.lang.String qualifiedName()  
      static java.lang.String simpleName()  
      StandardNaming standard()  
      java.lang.String toString()  
      java.lang.String value()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • 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

      • value

        private final java.lang.String value

      • depluralize

        private final boolean depluralize

    • Constructor Detail

      • NamingMirror

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

      • NamingMirror

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

      • find

        public static com.google.common.base.Optional<NamingMirror> 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 NamingMirror, present if this annotation found

      • fromAll

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

      • from

        public static NamingMirror 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:
        NamingMirror

      • from

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

      • value

        public java.lang.String value()
        Returns:
        value of attribute value

      • depluralize

        public boolean depluralize()
        Returns:
        value of attribute depluralize

      • standard

        public StandardNaming standard()
        Returns:
        value of attribute standard

      • 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:
        Naming.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