Package com.blamejared.crafttweaker_annotations.annotations

Class DocumentWrapper

java.lang.Object
com.blamejared.crafttweaker_annotations.annotations.DocumentWrapper
public class DocumentWrapper extends Object
Wrapper class to read attribute values from Annotation Document.

  • 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 Document.value from wrapped annotation.
      Returns:
      the attribute value

    • scriptFile

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

    • scriptFileIsDefaultValue

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

    • requiredModsAsAnnotationMirrorArray

      public AnnotationMirror[] requiredModsAsAnnotationMirrorArray()
      Gets the Document.requiredMods from wrapped annotation.
      Returns:
      the attribute value

    • requiredMods

      public ModWrapper[] requiredMods()
      Gets the Document.requiredMods from wrapped annotation.
      Returns:
      the attribute value

    • requiredModsIsDefaultValue

      public boolean requiredModsIsDefaultValue()
      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 : Document
      Parameters:
      element - The element to check for wrapped annotation type
      Returns:
      true, if passed element is annotated with Document annotation, otherwise false

    • wrap

      public static DocumentWrapper 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 DocumentWrapper 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 DocumentWrapper 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