Package com.atlassian.adf.model.node

Class Caption

java.lang.Object

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

com.atlassian.adf.model.node.AbstractContentNode<Caption,CaptionContent>

com.atlassian.adf.model.node.Caption

All Implemented Interfaces:

Element, Node, ContentNode<Caption,CaptionContent>

@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class Caption
extends AbstractContentNode<Caption,CaptionContent>

Wraps the caption content that may optionally be assigned to a mediaSingle node.

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
static Caption	caption()
static Caption	caption(CaptionContent content)
static Caption	caption(CaptionContent... content)
static Caption	caption(Iterable<? extends CaptionContent> content)
static Caption	caption(String content)
static Caption	caption(String... content)
static Caption	caption(Stream<? extends CaptionContent> content)
Caption	content(String content)
Caption	content(String... content)
Class<CaptionContent>	contentClass()	Returns Class<N>, the class representing the type of items held by this node.
Caption	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.

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

addContent, addContentIfPresent, allNodes, appendContentNodeFields, appendNodeFields, appendPlainText, appendPlainTextContentJoinedWith, appendPlainTextInlineContent, clear, content, content, content, content, content, contentFieldMaps, contentNodeEquals, contentNodeHashCode, contentNodeValidate, 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

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

toPlainText

Method Detail

caption

public static Caption caption()

caption

public static Caption caption(String content)

caption

public static Caption caption(String... content)

caption

public static Caption caption(CaptionContent content)

caption

public static Caption caption(CaptionContent... content)

caption

public static Caption caption(Iterable<? extends CaptionContent> content)

caption

public static Caption caption(Stream<? extends CaptionContent> content)

content

public Caption content(String content)

content

public Caption content(String... content)

contentClass

public Class<CaptionContent> contentClass()

Description copied from interface: ContentNode

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

copy

public Caption 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