Class DecisionList
- java.lang.Object
-
- com.atlassian.adf.model.node.AbstractNode<C>
-
- com.atlassian.adf.model.node.AbstractContentNode<DecisionList,DecisionItem>
-
- com.atlassian.adf.model.node.DecisionList
-
- All Implemented Interfaces:
Element,Node,ContentNode<DecisionList,DecisionItem>,DocContent,LayoutColumnContent,NonNestableBlockContent,TableCellContent
@Documentation(state=UNDOCUMENTED, date="2023-07-26") public class DecisionList extends AbstractContentNode<DecisionList,DecisionItem> implements DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent
Decision lists provide lists that look much like abulletList, but they cannot be nested and there are differences in their visual representation. The decision items also require identifier strings that can be used to associate them with information in other systems.Note: Jira does not currently support decision lists.
Example
Java
doc(p("Hello"),decisionList( "decision-list-id",decisionItem() .localId("item-test-id") .decided() .content("Start using Document Format for apps") ),p("World") );ADF
{ "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "Hello" } ] }, { "type": "decisionList", "attrs": { "localId": "decision-list-id" }, "content": [ { "type": "decisionItem", "attrs": { "localId": "item-test-id", "state": "DECIDED" }, "content": [ { "type": "text", "text": "Start using Document Format for apps" } ] } ] }, { "type": "paragraph", "content": [ { "type": "text", "text": "World" } ] } ] }Result
Hello
-
Start using Document Format for apps
World
Note: This example output is not using AtlasKit to render the decision list, so while it gives a vague impression of what a "decision list" is, it does not faithfully reproduce the actual presentation in Atlassian products.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDecisionList.PartialTypes that represent a partially constructeddecisionList.-
Nested classes/interfaces inherited from class com.atlassian.adf.model.node.AbstractNode
AbstractNode.ToStringHelper
-
-
Field Summary
-
Fields inherited from class com.atlassian.adf.model.node.AbstractContentNode
content
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidappendContentNodeFields(AbstractNode.ToStringHelper buf)Allows content nodes that have their own fields to augment thetoString()implementation with their own field values.Class<DecisionItem>contentClass()ReturnsClass<N>, the class representing the type of items held by this node.protected booleancontentNodeEquals(DecisionList other)Allows content nodes that have their own fields to augment theequalsimplementation with tests for their own field values.protected intcontentNodeHashCode()Allows content nodes that have their own fields to augment thehashCodeimplementation with a hash of their own field values.protected voidcontentNodeValidate()DecisionListcopy()Returns a deep copy of this element, including copies of any nodes or marks that it contains.static DecisionList.Partial.NeedsLocalIddecisionList()static DecisionListdecisionList(String localId)static DecisionListdecisionList(String localId, DecisionItem content)static DecisionListdecisionList(String localId, DecisionItem... content)static DecisionListdecisionList(String localId, Iterable<? extends DecisionItem> content)static DecisionListdecisionList(String localId, Stream<? extends DecisionItem> content)static DecisionListdecisionList(UUID localId)static DecisionListdecisionList(UUID localId, DecisionItem content)static DecisionListdecisionList(UUID localId, DecisionItem... content)static DecisionListdecisionList(UUID localId, Iterable<? extends DecisionItem> content)static DecisionListdecisionList(UUID localId, Stream<? extends DecisionItem> content)StringelementType()Thetypevalue that identifies this element, such as"paragraph"or"strong".StringlocalId()DecisionListlocalId(String localId)DecisionListlocalId(UUID localId)Map<String,?>toMap()Transforms this element to a map ofStringvalues to various basic object types suitable for direct rendering as JSON content.-
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, 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
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
-
decisionList
public static DecisionList.Partial.NeedsLocalId decisionList()
-
decisionList
public static DecisionList decisionList(String localId)
-
decisionList
public static DecisionList decisionList(String localId, DecisionItem content)
-
decisionList
public static DecisionList decisionList(String localId, DecisionItem... content)
-
decisionList
public static DecisionList decisionList(String localId, Iterable<? extends DecisionItem> content)
-
decisionList
public static DecisionList decisionList(String localId, Stream<? extends DecisionItem> content)
-
decisionList
public static DecisionList decisionList(UUID localId)
-
decisionList
public static DecisionList decisionList(UUID localId, DecisionItem content)
-
decisionList
public static DecisionList decisionList(UUID localId, DecisionItem... content)
-
decisionList
public static DecisionList decisionList(UUID localId, Iterable<? extends DecisionItem> content)
-
decisionList
public static DecisionList decisionList(UUID localId, Stream<? extends DecisionItem> content)
-
localId
public DecisionList localId(String localId)
-
localId
public DecisionList localId(UUID localId)
-
localId
public String localId()
-
contentClass
public Class<DecisionItem> contentClass()
Description copied from interface:ContentNodeReturnsClass<N>, the class representing the type of items held by this node.- Specified by:
contentClassin interfaceContentNode<DecisionList,DecisionItem>
-
copy
public DecisionList copy()
Description copied from interface:ElementReturns 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, atextnode that is used inside acodeBlockwill 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 thisif the element is immutable. The@Immutableannotation 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
parseandtoMapmethods already have to be updated in these circumstances, so it makes sense to take advantage of that.
- Specified by:
copyin interfaceContentNode<DecisionList,DecisionItem>- Specified by:
copyin interfaceElement- Specified by:
copyin interfaceNode- Returns:
- a copy of this element, or
thisif the element is immutable anyway
-
elementType
public String elementType()
Description copied from interface:ElementThetypevalue that identifies this element, such as"paragraph"or"strong".- Specified by:
elementTypein interfaceElement
-
toMap
public Map<String,?> toMap()
Description copied from interface:ElementTransforms this element to a map ofStringvalues to various basic object types suitable for direct rendering as JSON content.
-
contentNodeEquals
protected boolean contentNodeEquals(DecisionList other)
Description copied from class:AbstractContentNodeAllows content nodes that have their own fields to augment theequalsimplementation with tests for their own field values.Implementations need not check for identity,
null, or a different node class; those are already covered byAbstractNode.equals(Object). Implementations need not check theAbstractContentNode.content(), either; that is already covered byAbstractContentNode.nodeEquals(AbstractContentNode), which is expected to be this method's only consumer.Just as with the relationship between
hashCode,equals, andtoStringfor ordinary Java classes, subclasses ofAbstractContentNodeshould maintain consistent implementations ofcontentNodeHashCode,contentNodeEquals, andappendContentNodeFields.- Overrides:
contentNodeEqualsin classAbstractContentNode<DecisionList,DecisionItem>- Returns:
trueif all additional field values that belong to a particular type of content node test as equal;falseif differences are found- See Also:
AbstractContentNode.contentNodeHashCode(),AbstractContentNode.appendContentNodeFields(ToStringHelper)
-
contentNodeHashCode
protected int contentNodeHashCode()
Description copied from class:AbstractContentNodeAllows content nodes that have their own fields to augment thehashCodeimplementation 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 thecontent, either; that is already covered byAbstractNode.nodeHashCode(), which is expected to be this method's only consumer.Just as with the relationship between
hashCode,equals, andtoStringfor ordinary Java classes, subclasses ofAbstractContentNodeshould maintain consistent implementations ofcontentNodeHashCode,contentNodeEquals, andappendContentNodeFields.- Overrides:
contentNodeHashCodein classAbstractContentNode<DecisionList,DecisionItem>- 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:AbstractContentNodeAllows content nodes that have their own fields to augment thetoString()implementation with their own field values.Each field's value should be provided by calling
AbstractNode.ToStringHelper.appendField(String, Object). Thevaluemay benull, 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, andtoStringfor ordinary Java classes, subclasses ofAbstractContentNodeshould maintain consistent implementations ofcontentNodeHashCode,contentNodeEquals, andappendContentNodeFields.- Overrides:
appendContentNodeFieldsin classAbstractContentNode<DecisionList,DecisionItem>- Parameters:
buf- where the field values should be written- See Also:
AbstractContentNode.contentNodeHashCode(),AbstractContentNode.contentNodeEquals(AbstractContentNode)
-
contentNodeValidate
protected void contentNodeValidate()
- Overrides:
contentNodeValidatein classAbstractContentNode<DecisionList,DecisionItem>
-
-