Package com.atlassian.adf.model.node

Class InlineExtension

java.lang.Object

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

com.atlassian.adf.model.node.AbstractMarkedNode<InlineExtension,InlineExtensionMark>

com.atlassian.adf.model.node.InlineExtension

All Implemented Interfaces:

Element, Node, ExtensionNode<InlineExtension,InlineExtensionMark>, InlineContent, Marked<InlineExtension,InlineExtensionMark>

@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class InlineExtension
extends AbstractMarkedNode<InlineExtension,InlineExtensionMark>
implements ExtensionNode<InlineExtension,InlineExtensionMark>, InlineContent

Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered. The inlineExtension node type is used in contexts that only permit "inline" content, such as paragraph and heading.

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.
InlineExtension	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	extensionKey()
InlineExtension	extensionKey(String extensionKey)	Replace the extension's key.
String	extensionType()
InlineExtension	extensionType(String extensionType)	Replace the extension's type.
static ExtensionSettings.Partial.NeedsExtensionKey<InlineExtension>	inlineExtension()
static InlineExtension	inlineExtension(String extensionKey, String extensionType)
Optional<String>	localId()
InlineExtension	localId(String localId)	Replaces (or clears) the extension's local ID.
Class<InlineExtensionMark>	markClass()	Returns the type of marks that may be applied to this node.
protected boolean	markedNodeEquals(InlineExtension other)
protected int	markedNodeHashCode()
Optional<Map<String,?>>	parameters()
InlineExtension	parameters(Map<String,?> parameters)	Replaces (or clears) the extension's parameter map.
Optional<String>	text()
InlineExtension	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

inlineExtension

@CheckReturnValue
public static ExtensionSettings.Partial.NeedsExtensionKey<InlineExtension> inlineExtension()

inlineExtension

public static InlineExtension inlineExtension(String extensionKey,
                                              String extensionType)

copy

public InlineExtension 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<InlineExtension,InlineExtensionMark>

Specified by:

copy in interface Marked<InlineExtension,InlineExtensionMark>

Specified by:

copy in interface Node

Specified by:

copy in class AbstractMarkedNode<InlineExtension,InlineExtensionMark>

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<InlineExtensionMark> markClass()

Description copied from interface: Marked

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

Specified by:

markClass in interface Marked<InlineExtension,InlineExtensionMark>

Specified by:

markClass in class AbstractMarkedNode<InlineExtension,InlineExtensionMark>

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<InlineExtension,InlineExtensionMark>

markedNodeEquals

protected boolean markedNodeEquals(InlineExtension other)

Overrides:

markedNodeEquals in class AbstractMarkedNode<InlineExtension,InlineExtensionMark>

appendMarkedNodeFields

protected void appendMarkedNodeFields(AbstractNode.ToStringHelper buf)

Overrides:

appendMarkedNodeFields in class AbstractMarkedNode<InlineExtension,InlineExtensionMark>

extensionKey

public String extensionKey()

Specified by:

extensionKey in interface ExtensionNode<InlineExtension,InlineExtensionMark>

Returns:

the extension's key

extensionKey

public InlineExtension extensionKey(String extensionKey)

Description copied from interface: ExtensionNode

Replace the extension's key.

Specified by:

extensionKey in interface ExtensionNode<InlineExtension,InlineExtensionMark>

Parameters:

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

Returns:

this

extensionType

public String extensionType()

Specified by:

extensionType in interface ExtensionNode<InlineExtension,InlineExtensionMark>

Returns:

the extension's type

extensionType

public InlineExtension extensionType(String extensionType)

Description copied from interface: ExtensionNode

Replace the extension's type.

Specified by:

extensionType in interface ExtensionNode<InlineExtension,InlineExtensionMark>

Parameters:

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

Returns:

this

localId

public InlineExtension localId(@Nullable
                               String localId)

Description copied from interface: ExtensionNode

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

Specified by:

localId in interface ExtensionNode<InlineExtension,InlineExtensionMark>

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<InlineExtension,InlineExtensionMark>

Returns:

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

text

public InlineExtension text(@Nullable
                            String text)

Description copied from interface: ExtensionNode

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

Specified by:

text in interface ExtensionNode<InlineExtension,InlineExtensionMark>

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<InlineExtension,InlineExtensionMark>

Returns:

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

parameters

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

Description copied from interface: ExtensionNode

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

Specified by:

parameters in interface ExtensionNode<InlineExtension,InlineExtensionMark>

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<InlineExtension,InlineExtensionMark>

Returns:

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

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<InlineExtension>

Parameters:

sb - where to write the result