Package com.atlassian.adf.model.node

Class BulletList

java.lang.Object

com.atlassian.adf.model.node.AbstractNode<C>

com.atlassian.adf.model.node.AbstractContentNode<L,ListItem>

com.atlassian.adf.model.node.AbstractListNode<BulletList>

com.atlassian.adf.model.node.BulletList

All Implemented Interfaces:

Element, Node, ContentNode<BulletList,ListItem>, DocContent, LayoutColumnContent, ListItemContent, ListNode<BulletList>, NonNestableBlockContent, PanelContent, TableCellContent

@Documentation(state=REVIEWED,
               date="2023-07-26")
public class BulletList
extends AbstractListNode<BulletList>

A container for list items that produces a bulleted list.

Example

Java

 bulletList()
         .li("Hello")
         .li("World");
 

ADF

   {
     "type": "bulletList",
     "content": [
       {
         "type": "listItem",
         "content": [
           {
             "type": "paragraph",
             "content": [
               {
                 "type": "text",
                 "text": "Hello"
               }
             ]
           }
         ]
       },
       {
         "type": "listItem",
         "content": [
           {
             "type": "paragraph",
             "content": [
               {
                 "type": "text",
                 "text": "World"
               }
             ]
           }
         ]
       }
     ]
   }
 

Result

• Hello

• World

See Also:

Node - bulletList

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.adf.model.node.AbstractNode

AbstractNode.ToStringHelper

Nested classes/interfaces inherited from interface com.atlassian.adf.model.node.Node

Node.Attr, Node.Key, Node.Type

Field Summary

Fields inherited from class com.atlassian.adf.model.node.AbstractContentNode

content

Method Summary

Modifier and Type	Method	Description
void	appendPlainText(StringBuilder sb)	Renders this node as plain-text suitable for viewing by end users.
static BulletList	bulletList()
static BulletList	bulletList(ListItem... content)
static BulletList	bulletList(Iterable<? extends ListItem> content)
static BulletList	bulletList(Stream<? extends ListItem> content)
BulletList	copy()	Returns a deep copy of this element, including copies of any nodes or marks that it contains.
String	elementType()	The type value that identifies this element, such as "paragraph" or "strong".
Map<String,?>	toMap()	Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
static BulletList	ul()
static BulletList	ul(ListItem... content)
static BulletList	ul(Iterable<? extends ListItem> content)
static BulletList	ul(Stream<? extends ListItem> content)

Methods inherited from class com.atlassian.adf.model.node.AbstractListNode

contentClass, contentNodeValidate, li, li, li, li, li, li

Methods inherited from class com.atlassian.adf.model.node.AbstractContentNode

addContent, addContentIfPresent, allNodes, appendContentNodeFields, appendNodeFields, appendPlainTextContentJoinedWith, appendPlainTextInlineContent, clear, content, content, content, content, content, contentFieldMaps, contentNodeEquals, contentNodeHashCode, isEmpty, nodeEquals, nodeHashCode, parseContentItem, parseContentItems, parseOptionalContent, parseRequiredContent, parseRequiredContentAllowEmpty, removeIf, replaceContent, requireNotEmpty, transformContent, transformDescendants, trim, validate, validateContentItems, validateContentNodeForAppend

Methods inherited from class com.atlassian.adf.model.node.AbstractNode

doubleEq, doubleHash, equals, hashCode, isSupported, mapWithType, numberEq, numberHash, self, toPlainText, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.adf.model.node.type.ContentNode

allNodes, allNodesOfType, allNodesOfTypeAsList, clear, content, content, content, content, content, isEmpty, removeIf, replaceContent, transformContent, transformDescendants

Methods inherited from interface com.atlassian.adf.model.Element

isSupported, validate

Methods inherited from interface com.atlassian.adf.model.node.Node

toPlainText

Method Detail

ul

public static BulletList ul()

Returns:

a new, empty bulleted list. At least one list item must be added before it will be valid.

ul

public static BulletList ul(ListItem... content)

Returns:

a new bulleted list with the given contents

ul

public static BulletList ul(Iterable<? extends ListItem> content)

Returns:

a new bulleted list with the given contents

ul

public static BulletList ul(Stream<? extends ListItem> content)

Returns:

a new bulleted list with the given contents

bulletList

public static BulletList bulletList()

See Also:

ul()

bulletList

public static BulletList bulletList(ListItem... content)

See Also:

ul(ListItem[])

bulletList

public static BulletList bulletList(Iterable<? extends ListItem> content)

See Also:

ul(Iterable)

bulletList

public static BulletList bulletList(Stream<? extends ListItem> content)

See Also:

ul(Stream)

copy

public BulletList copy()

Description copied from interface: Element

Returns a deep copy of this element, including copies of any nodes or marks that it contains. The copy will not necessarily be in exactly the same state as the original in some cases. For example, a text node that is used inside a codeBlock will have the ability to use marks on it disabled, but a copy made of the text node using this method will not similarly disallow marks unless it is also added to a content node with those same restrictions.

Implementations notes:

• Implementations should narrow the return type.
• Implementations should return this if the element is immutable. The @Immutable annotation should be used on the class to offer additional confirmation of this intent.
• Implementations should return parse(toMap()) if they have state.
• While there may be cases where it is worthwhile to do something more efficient than the conversion to a map and back, this is discouraged because it would add yet another fragile piece of code that breaks when new data is added to the node. The parse and toMap methods already have to be updated in these circumstances, so it makes sense to take advantage of that.

Returns:

a copy of this element, or this if the element is immutable anyway

elementType

public String elementType()

Description copied from interface: Element

The type value that identifies this element, such as "paragraph" or "strong".

toMap

public Map<String,?> toMap()

Description copied from interface: Element

Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.

Returns:

the map representation of this ADF element

appendPlainText

public void appendPlainText(StringBuilder sb)

Description copied from interface: Node

Renders this node as plain-text suitable for viewing by end users. This is equivalent to calling Node.toPlainText() and appending the result to the given buffer, except that it may be slightly more efficient, since it will write directly to the existing buffer instead of using a temporary buffer and having to make a copy of the result.

Specified by:

appendPlainText in interface Node

Overrides:

appendPlainText in class AbstractContentNode<BulletList,ListItem>

Parameters:

sb - where to write the result