Package com.atlassian.adf.model.node

Class TaskList

java.lang.Object

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

com.atlassian.adf.model.node.AbstractContentNode<TaskList,TaskListContent>

com.atlassian.adf.model.node.TaskList

All Implemented Interfaces:

Element, Node, ContentNode<TaskList,TaskListContent>, DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent, TaskListContent

@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class TaskList
extends AbstractContentNode<TaskList,TaskListContent>
implements DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent, TaskListContent

Task lists provide lists that look much like a bulletList, but there are differences in their visual representation. They can be nested (although at least one taskItem has to be provided before any nested task lists). The task items also require identifier strings that can be used to associate them with information in other systems.

Note: Jira does not currently support task lists.

Example

Java

     taskList(
         "test-list-id",
         taskItem()
                 .todo()
                 .localId("test-id1")
                 .content("Do this!"),
         taskItem()
                 .localId("test-id2")
                 .state(DONE)
                 .content("This is completed")
     );
 

ADF

 {
   "type": "taskList",
   "attrs": {
     "localId": "test-list-id"
   },
   "content": [
     {
       "type": "taskItem",
       "attrs": {
         "localId": "test-id1",
         "state": "TODO"
       },
       "content": [
         {
           "type": "text",
           "text": "Do this!"
         }
       ]
     },
     {
       "type": "taskItem",
       "attrs": {
         "localId": "test-id2",
         "state": "DONE"
       },
       "content": [
         {
           "type": "text",
           "text": "This is completed"
         }
       ]
     }
   ]
 }
 

Result

Do this!

This is completed

Note: This example output is not using AtlasKit to render the task list, so while it gives a vague impression of what a "task list" is, it does not faithfully reproduce the actual presentation in Atlassian products. In particular, the checkboxes are displayed here without the proper styling.

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
protected void	appendContentNodeFields(AbstractNode.ToStringHelper buf)	Allows content nodes that have their own fields to augment the toString() implementation with their own field values.
Class<TaskListContent>	contentClass()	Returns Class<N>, the class representing the type of items held by this node.
protected boolean	contentNodeEquals(TaskList other)	Allows content nodes that have their own fields to augment the equals implementation with tests for their own field values.
protected int	contentNodeHashCode()	Allows content nodes that have their own fields to augment the hashCode implementation with a hash of their own field values.
protected void	contentNodeValidate()
TaskList	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".
String	localId()
TaskList	localId(String localId)
static TaskList	taskList(String localId)
static TaskList	taskList(String localId, TaskListContent content)
static TaskList	taskList(String localId, TaskListContent... content)
static TaskList	taskList(String localId, Iterable<? extends TaskListContent> content)
static TaskList	taskList(String localId, Stream<? extends TaskListContent> content)
Map<String,?>	toMap()	Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
protected void	validateContentNodeForAppend(TaskListContent node)	Called on each content node before it is added to validate that the node can be accepted.

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

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

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

allNodesOfType, allNodesOfTypeAsList

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

isSupported, validate

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

appendPlainText, toPlainText

Method Detail

taskList

public static TaskList taskList(String localId)

taskList

public static TaskList taskList(String localId,
                                TaskListContent content)

taskList

public static TaskList taskList(String localId,
                                TaskListContent... content)

taskList

public static TaskList taskList(String localId,
                                Iterable<? extends TaskListContent> content)

taskList

public static TaskList taskList(String localId,
                                Stream<? extends TaskListContent> content)

localId

public TaskList localId(String localId)

localId

public String localId()

contentClass

public Class<TaskListContent> contentClass()

Description copied from interface: ContentNode

Returns Class<N>, the class representing the type of items held by this node.

Specified by:

contentClass in interface ContentNode<TaskList,TaskListContent>

copy

public TaskList 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.

Specified by:

copy in interface ContentNode<TaskList,TaskListContent>

Specified by:

copy in interface Element

Specified by:

copy in interface Node

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".

Specified by:

elementType in interface Element

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.

Specified by:

toMap in interface Element

Returns:

the map representation of this ADF element

contentNodeEquals

protected boolean contentNodeEquals(TaskList other)

Description copied from class: AbstractContentNode

Allows content nodes that have their own fields to augment the equals implementation with tests for their own field values.

Implementations need not check for identity, null, or a different node class; those are already covered by AbstractNode.equals(Object). Implementations need not check the AbstractContentNode.content(), either; that is already covered by AbstractContentNode.nodeEquals(AbstractContentNode), which is expected to be this method's only consumer.

Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.

Overrides:

contentNodeEquals in class AbstractContentNode<TaskList,TaskListContent>

Returns:

true if all additional field values that belong to a particular type of content node test as equal; false if differences are found

See Also:

AbstractContentNode.contentNodeHashCode(), AbstractContentNode.appendContentNodeFields(ToStringHelper)

contentNodeHashCode

protected int contentNodeHashCode()

Description copied from class: AbstractContentNode

Allows content nodes that have their own fields to augment the hashCode implementation with a hash of their own field values.

Implementations need not include the node's class; that is already covered by AbstractNode.hashCode(). Implementations need not include the content, either; that is already covered by AbstractNode.nodeHashCode(), which is expected to be this method's only consumer.

Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.

Overrides:

contentNodeHashCode in class AbstractContentNode<TaskList,TaskListContent>

Returns:

the hash code of any additional field values that belong to a particular type of content node.

See Also:

AbstractContentNode.contentNodeEquals(AbstractContentNode), AbstractContentNode.appendContentNodeFields(ToStringHelper)

appendContentNodeFields

protected void appendContentNodeFields(AbstractNode.ToStringHelper buf)

Description copied from class: AbstractContentNode

Allows content nodes that have their own fields to augment the toString() implementation with their own field values.

Each field's value should be provided by calling AbstractNode.ToStringHelper.appendField(String, Object). The value may be null, in which case the field is omitted, for brevity. It will handle array values gracefully, including arrays of primitive types.

Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.

Overrides:

appendContentNodeFields in class AbstractContentNode<TaskList,TaskListContent>

Parameters:

buf - where the field values should be written

See Also:

AbstractContentNode.contentNodeHashCode(), AbstractContentNode.contentNodeEquals(AbstractContentNode)

validateContentNodeForAppend

protected void validateContentNodeForAppend(TaskListContent node)

Description copied from class: AbstractContentNode

Called on each content node before it is added to validate that the node can be accepted.

Overrides:

validateContentNodeForAppend in class AbstractContentNode<TaskList,TaskListContent>

Parameters:

node - the node that is about to be added

contentNodeValidate

protected void contentNodeValidate()

Overrides:

contentNodeValidate in class AbstractContentNode<TaskList,TaskListContent>