Package com.atlassian.adf.model.node

Class Extension

java.lang.Object

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

com.atlassian.adf.model.node.AbstractMarkedNode<Extension,ExtensionMark>

com.atlassian.adf.model.node.Extension

All Implemented Interfaces:

Element, Node, DocContent, ExtensionNode<Extension,ExtensionMark>, LayoutColumnContent, Marked<Extension,ExtensionMark>, NonNestableBlockContent, TableCellContent

@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class Extension
extends AbstractMarkedNode<Extension,ExtensionMark>
implements ExtensionNode<Extension,ExtensionMark>, DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent

Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered. Like bodiedExtension nodes, the generic extension node type is used in contexts that only permit "block" content, such as the top-level doc node itself. However, there are some important differences:

• extension nodes are leaves, but bodiedExtension nodes wrap other content
• extension nodes can be used in places that bodiedExtension can not, such as inside tableCell, tableHeader, or bodiedExtension itself.

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

marks

Method Summary

Modifier and Type	Method	Description
protected void	appendMarkedNodeFields(AbstractNode.ToStringHelper buf)
void	appendPlainText(StringBuilder sb)	Renders this node as plain-text suitable for viewing by end users.
Extension	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".
static ExtensionSettings.Partial.NeedsExtensionKey<Extension>	extension()
static Extension	extension(String extensionKey, String extensionType)
String	extensionKey()
Extension	extensionKey(String extensionKey)	Replace the extension's key.
String	extensionType()
Extension	extensionType(String extensionType)	Replace the extension's type.
Optional<ExtensionSettings.Layout>	layout()
Extension	layout(ExtensionSettings.Layout layout)
Extension	layout(String layout)
Optional<String>	localId()
Extension	localId(String localId)	Replaces (or clears) the extension's local ID.
Class<ExtensionMark>	markClass()	Returns the type of marks that may be applied to this node.
protected boolean	markedNodeEquals(Extension other)
protected int	markedNodeHashCode()
Optional<Map<String,?>>	parameters()
Extension	parameters(Map<String,?> parameters)	Replaces (or clears) the extension's parameter map.
Optional<String>	text()
Extension	text(String text)	Replaces (or clears) the extension's text value.
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.AbstractMarkedNode

appendNodeFields, createMarkHolder, mark, mark, markedNodeValidate, marks, marks, markTypes, nodeEquals, nodeHashCode, parseMarks, unsupportedMarkFactory, validate

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

isSupported, validate

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

mark, mark, marks, marks, markTypes

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

toPlainText

Method Detail

extension

@CheckReturnValue
public static ExtensionSettings.Partial.NeedsExtensionKey<Extension> extension()

extension

public static Extension extension(String extensionKey,
                                  String extensionType)

copy

public Extension 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 Element

Specified by:

copy in interface ExtensionNode<Extension,ExtensionMark>

Specified by:

copy in interface Marked<Extension,ExtensionMark>

Specified by:

copy in interface Node

Specified by:

copy in class AbstractMarkedNode<Extension,ExtensionMark>

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

markClass

public Class<ExtensionMark> markClass()

Description copied from interface: Marked

Returns the type of marks that may be applied to this node.

Specified by:

markClass in interface Marked<Extension,ExtensionMark>

Specified by:

markClass in class AbstractMarkedNode<Extension,ExtensionMark>

Returns:

the type of marks that may be applied to this node, which is the concrete type for the generic type <M> on this interface.

markedNodeHashCode

protected int markedNodeHashCode()

Overrides:

markedNodeHashCode in class AbstractMarkedNode<Extension,ExtensionMark>

markedNodeEquals

protected boolean markedNodeEquals(Extension other)

Overrides:

markedNodeEquals in class AbstractMarkedNode<Extension,ExtensionMark>

appendMarkedNodeFields

protected void appendMarkedNodeFields(AbstractNode.ToStringHelper buf)

Overrides:

appendMarkedNodeFields in class AbstractMarkedNode<Extension,ExtensionMark>

extensionKey

public String extensionKey()

Specified by:

extensionKey in interface ExtensionNode<Extension,ExtensionMark>

Returns:

the extension's key

extensionKey

public Extension extensionKey(String extensionKey)

Description copied from interface: ExtensionNode

Replace the extension's key.

Specified by:

extensionKey in interface ExtensionNode<Extension,ExtensionMark>

Parameters:

extensionKey - the new extension key value; must not be empty

Returns:

this

extensionType

public String extensionType()

Specified by:

extensionType in interface ExtensionNode<Extension,ExtensionMark>

Returns:

the extension's type

extensionType

public Extension extensionType(String extensionType)

Description copied from interface: ExtensionNode

Replace the extension's type.

Specified by:

extensionType in interface ExtensionNode<Extension,ExtensionMark>

Parameters:

extensionType - the new extension type value; must not be empty

Returns:

this

localId

public Extension localId(@Nullable
                         String localId)

Description copied from interface: ExtensionNode

Replaces (or clears) the extension's local ID.

Specified by:

localId in interface ExtensionNode<Extension,ExtensionMark>

Parameters:

localId - the extension's new local ID, or null to clear it.

Returns:

this

localId

public Optional<String> localId()

Specified by:

localId in interface ExtensionNode<Extension,ExtensionMark>

Returns:

the extension's local ID, or empty if it has not been set

text

public Extension text(@Nullable
                      String text)

Description copied from interface: ExtensionNode

Replaces (or clears) the extension's text value.

Specified by:

text in interface ExtensionNode<Extension,ExtensionMark>

Parameters:

text - the extension's new text value, or null to clear it.

Returns:

this

text

public Optional<String> text()

Specified by:

text in interface ExtensionNode<Extension,ExtensionMark>

Returns:

the extension's text value, or empty if it has not been set

parameters

public Extension parameters(@Nullable
                            Map<String,?> parameters)

Description copied from interface: ExtensionNode

Replaces (or clears) the extension's parameter map.

Specified by:

parameters in interface ExtensionNode<Extension,ExtensionMark>

Parameters:

parameters - the extension's new parameter map, or null to discard any existing one.

Returns:

this

parameters

public Optional<Map<String,?>> parameters()

Specified by:

parameters in interface ExtensionNode<Extension,ExtensionMark>

Returns:

the extension's parameter map, or empty if it has not been set

layout

public Extension layout(@Nullable
                        String layout)

layout

public Extension layout(@Nullable
                        ExtensionSettings.Layout layout)

layout

public Optional<ExtensionSettings.Layout> layout()

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 AbstractNode<Extension>

Parameters:

sb - where to write the result