Package org.immutables.value.processor.encode

Class NamingMirror

java.lang.Object
org.immutables.value.processor.encode.NamingMirror
All Implemented Interfaces:
Annotation
public class NamingMirror extends 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:

  • Field Details

  • Constructor Details

    • NamingMirror

      private NamingMirror(TypeElement defaultAnnotationElement)

    • NamingMirror

      private NamingMirror(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<NamingMirror> find(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(Iterable<? extends 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(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 NamingMirrors

    • from

      public static NamingMirror from(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(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 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 AnnotationMirror getAnnotationMirror()
      Returns:
      underlying annotation mirror

    • annotationType

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