Package groovy.lang.groovydoc

Class Groovydoc

java.lang.Object
groovy.lang.groovydoc.Groovydoc
public class Groovydoc
extends java.lang.Object
Represents groovydoc

  • Field Summary

    Fields
    Modifier and Type Field Description
    static Groovydoc EMPTY_GROOVYDOC  

  • Constructor Summary

    Constructors
    Constructor Description
    Groovydoc​(java.lang.String content, GroovydocHolder groovydocHolder)  
    Groovydoc​(java.lang.String content, java.lang.reflect.AnnotatedElement annotatedElement)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    java.lang.String getContent()
    Get the content of groovydoc
    GroovydocHolder getHolder()
    Get the holder of the groovydoc
    java.util.List<GroovydocTag> getTagList()
    TODO Get list of groovydoc tags
    int hashCode()  
    boolean isPresent()
    Tests if groovydoc is present
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Field Details

    • EMPTY_GROOVYDOC

      public static final Groovydoc EMPTY_GROOVYDOC

  • Constructor Details

    • Groovydoc

      public Groovydoc​(java.lang.String content, GroovydocHolder groovydocHolder)

    • Groovydoc

      public Groovydoc​(java.lang.String content, java.lang.reflect.AnnotatedElement annotatedElement)

  • Method Details

    • isPresent

      public boolean isPresent()
      Tests if groovydoc is present
      Returns:
      true if groovydoc is present

    • getContent

      public java.lang.String getContent()
      Get the content of groovydoc
      Returns:
      the text content

    • getTagList

      public java.util.List<GroovydocTag> getTagList()
      TODO Get list of groovydoc tags
      Returns:
      a list of tags

    • getHolder

      public GroovydocHolder getHolder()
      Get the holder of the groovydoc
      Returns:
      the groovydoc holder

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object