Class JCommentPart

All Implemented Interfaces:
Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, SequencedCollection<Object>
Direct Known Subclasses:
JDocComment

public class JCommentPart extends ArrayList<Object>
A part is a part of a javadoc comment, and it is a list of values.

A part can contain a free-form text. This text is modeled as a collection of 'values' in this class. A value can be a JType (which will be prinited with a @link tag), anything that can be turned into a String via the Object.toString() method, or a Collection/array of those objects.

Values can be added through the various append methods one by one or in a bulk.

See Also:
  • Field Details

  • Constructor Details

    • JCommentPart

      public JCommentPart()
  • Method Details

    • append

      public JCommentPart append(Object o)
      Appends a new value. If the value is JType it will be printed as a @link tag. Otherwise it will be converted to String via Object.toString().
    • add

      public boolean add(Object o)
      Specified by:
      add in interface Collection<Object>
      Specified by:
      add in interface List<Object>
      Overrides:
      add in class ArrayList<Object>
    • flattenAppend

      private void flattenAppend(Object value)
    • format

      protected void format(JFormatter f, String indent)
      Writes this part into the formatter by using the specified indentation.
    • escape

      private String escape(String s)
      Escapes the appearance of the comment terminator.