Package com.atlassian.adf.model.node

Class AbstractMarkedContentNode<C extends AbstractMarkedContentNode<C,N,M>,N extends Node,M extends Mark>

java.lang.Object

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

com.atlassian.adf.model.node.AbstractContentNode<C,N>

com.atlassian.adf.model.node.AbstractMarkedContentNode<C,N,M>

All Implemented Interfaces:

Element, Node, ContentNode<C,N>, Marked<C,M>

Direct Known Subclasses:

BodiedExtension, CodeBlock, Expand, Heading, LayoutSection, Paragraph, Table

@Internal
public abstract class AbstractMarkedContentNode<C extends AbstractMarkedContentNode<C,N,M>,N extends Node,M extends Mark>
extends AbstractContentNode<C,N>
implements ContentNode<C,N>, Marked<C,M>

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

Modifier and Type	Field	Description
protected com.atlassian.adf.model.node.MarkHolder<M>	marks

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.
protected void	appendMarkedContentNodeFields(AbstractNode.ToStringHelper buf)
protected boolean	contentNodeEquals(C 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()
protected com.atlassian.adf.model.node.MarkHolder<M>	createMarkHolder()
Optional<M>	mark(String markType)	Returns the existing mark of the given type, if it exists.
C	mark(M mark)	Adds the given mark to this marked node.
abstract Class<M>	markClass()	Returns the type of marks that may be applied to this node.
protected boolean	markedContentNodeEquals(C other)
protected int	markedContentNodeHashCode()
protected void	markedContentNodeValidate()
Collection<M>	marks()	Returns a list of the marks currently assigned to this node.
<T extends M> Stream<? extends T>	marks(Class<T> markClass)	Returns a stream of the marks that are currently assigned to this node and match the given type.
Set<String>	markTypes()	Returns a set of all the mark types that have been assigned to this node.
protected C	parseMarks(Map<String,?> map)
protected Factory<M>	unsupportedMarkFactory()

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

allNodes, allNodesOfType, allNodesOfTypeAsList, clear, content, content, content, content, content, contentClass, copy, isEmpty, removeIf, replaceContent, transformContent, transformDescendants

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

elementType, isSupported, toMap, validate

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

copy

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

appendPlainText, toPlainText

Field Detail

marks

protected final com.atlassian.adf.model.node.MarkHolder<M extends Mark> marks

Method Detail

markClass

public abstract Class<M> markClass()

Description copied from interface: Marked

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

Specified by:

markClass in interface Marked<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

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.

createMarkHolder

protected com.atlassian.adf.model.node.MarkHolder<M> createMarkHolder()

marks

public final Collection<M> marks()

Description copied from interface: Marked

Returns a list of the marks currently assigned to this node.

Specified by:

marks in interface Marked<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

Returns:

a list of the marks currently assigned to this node.

markTypes

public final Set<String> markTypes()

Description copied from interface: Marked

Returns a set of all the mark types that have been assigned to this node.

Specified by:

markTypes in interface Marked<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

Returns:

a set of all the mark types that have been assigned to this node.

marks

public final <T extends M> Stream<? extends T> marks(Class<T> markClass)

Description copied from interface: Marked

Returns a stream of the marks that are currently assigned to this node and match the given type.

Since only one mark of each type is permitted to be assigned to a single node, the stream will not contain multiple elements when markClass is a concrete mark class.

Specified by:

marks in interface Marked<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

Type Parameters:

T - the inferred mark class

Parameters:

markClass - the mark types to be included in the stream

Returns:

the stream of matching marks

mark

public final Optional<M> mark(String markType)

Description copied from interface: Marked

Returns the existing mark of the given type, if it exists.

Specified by:

mark in interface Marked<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

Parameters:

markType - the mark type to look up

Returns:

the existing mark, or empty if no such mark does exist

mark

public C mark(M mark)

Description copied from interface: Marked

Adds the given mark to this marked node.

Specified by:

mark in interface Marked<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

Parameters:

mark - the mark to be added

Returns:

this

parseMarks

protected C parseMarks(Map<String,?> map)

contentNodeValidate

protected final void contentNodeValidate()

Overrides:

contentNodeValidate in class AbstractContentNode<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

markedContentNodeValidate

protected void markedContentNodeValidate()

unsupportedMarkFactory

@Nullable
protected Factory<M> unsupportedMarkFactory()

contentNodeHashCode

protected final 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<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

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)

contentNodeEquals

protected final boolean contentNodeEquals(C 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<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

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)

appendContentNodeFields

protected final 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<C extends AbstractMarkedContentNode<C,N,M>,N extends Node>

Parameters:

buf - where the field values should be written

See Also:

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

markedContentNodeHashCode

protected int markedContentNodeHashCode()

markedContentNodeEquals

protected boolean markedContentNodeEquals(C other)

appendMarkedContentNodeFields

protected void appendMarkedContentNodeFields(AbstractNode.ToStringHelper buf)