Class JavadocSnippet

  • All Implemented Interfaces:
    JavadocDescriptionElement

    public class JavadocSnippet
    extends java.lang.Object
    implements JavadocDescriptionElement
    A piece of text inside a Javadoc description.

    For example in A class totally unrelated to String, I swear! we would have two snippets: one before and one after the inline tag (String).

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String text  
    • Constructor Summary

      Constructors 
      Constructor Description
      JavadocSnippet​(java.lang.String text)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      int hashCode()  
      java.lang.String toString()  
      java.lang.String toText()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • text

        private java.lang.String text
    • Constructor Detail

      • JavadocSnippet

        public JavadocSnippet​(java.lang.String text)
    • Method Detail

      • 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