Module com.sun.codemodel
Package com.sun.codemodel

Class JCommentPart

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.List<java.lang.Object>, java.util.RandomAccess
    Direct Known Subclasses:
    JDocComment
    public class JCommentPart
extends java.util.ArrayList<java.lang.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.

    Author:
    Kohsuke Kawaguchi
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class java.util.AbstractList

        modCount

    • Constructor Summary

      Constructors 
      Constructor Description
      JCommentPart()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(java.lang.Object o)  
      JCommentPart append​(java.lang.Object o)
      Appends a new value.
      protected void format​(JFormatter f, java.lang.String indent)
      Writes this part into the formatter by using the specified indentation.

      • Methods inherited from class java.util.ArrayList

        add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

      • Methods inherited from class java.util.AbstractCollection

        containsAll, toString

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Collection

        parallelStream, stream, toArray

      • Methods inherited from interface java.util.List

        containsAll

    • Constructor Detail

      • JCommentPart

        public JCommentPart()

    • Method Detail

      • append

        public JCommentPart append​(java.lang.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​(java.lang.Object o)
        Specified by:
        add in interface java.util.Collection<java.lang.Object>
        Specified by:
        add in interface java.util.List<java.lang.Object>
        Overrides:
        add in class java.util.ArrayList<java.lang.Object>

      • format

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