Package org.openzen.zencode.java

Class OptionalStringWrapper

java.lang.Object
org.openzen.zencode.java.OptionalStringWrapper
public class OptionalStringWrapper extends Object
Wrapper class to read attribute values from Annotation OptionalString.

  • Method Details

    • _annotatedElement

      public Element _annotatedElement()
      Gets the element on which the wrapped annotation is used.

    • _annotationMirror

      public AnnotationMirror _annotationMirror()
      Gets the wrapped AnnotationMirror.

    • value

      public String value()
      Gets the OptionalString.value from wrapped annotation.
      Returns:
      the attribute value

    • valueIsDefaultValue

      public boolean valueIsDefaultValue()
      Allows to check if attribute was explicitly set or if default value is used.
      Returns:
      true, if default value is used, otherwise false

    • isAnnotated

      public static boolean isAnnotated(Element element)
      Checks if passed element is annotated with this wrapper annotation type : OptionalString
      Parameters:
      element - The element to check for wrapped annotation type
      Returns:
      true, if passed element is annotated with OptionalString annotation, otherwise false

    • wrap

      public static OptionalStringWrapper wrap(Element element)
      Gets the AnnotationMirror from passed element for this wrappers annotation type and creates a wrapper instance.
      Parameters:
      element - The element to read the annotations from
      Returns:
      The wrapped AnnotationMirror if Element is annotated with this wrappers annotation type, otherwise null.

    • wrap

      public static OptionalStringWrapper wrap(AnnotationMirror annotationMirror)
      Wraps an AnnotationMirror. Throws an IllegalArgumentException if passed AnnotationMirror type doesn't match the wrapped annotation type.
      Parameters:
      annotationMirror - The element annotated with the annotation to wrap
      Returns:
      The wrapper instance

    • wrap

      public static OptionalStringWrapper wrap(Element element, AnnotationMirror annotationMirror)
      Wraps an AnnotationMirror. Throws an IllegalArgumentException if passed AnnotationMirror type doesn't match the wrapped annotation type.
      Parameters:
      element - the element bound to the usage of passed AnnotationMirror
      annotationMirror - The AnnotationMirror to wrap
      Returns:
      The wrapper instance