Package com.atlassian.adf.model.mark.unsupported

Class UnsupportedTextMark

java.lang.Object

com.atlassian.adf.model.UnsupportedElement

com.atlassian.adf.model.mark.unsupported.UnsupportedTextMark

All Implemented Interfaces:

Element, Mark, CodeTextMark, FormattedTextMark, TextMark

@Immutable
@Internal
public class UnsupportedTextMark
extends UnsupportedElement
implements CodeTextMark, FormattedTextMark

Represents some unknown mark that was used on a text node.

It is assumed to be usable as either a code or formatted-text mark. It cannot be modified, but its state will be preserved if possible.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.adf.model.Element

Element.Attr, Element.Key

Nested classes/interfaces inherited from interface com.atlassian.adf.model.mark.Mark

Mark.Attr, Mark.Type

Field Summary

Fields

Modifier and Type	Field	Description
static Factory<TextMark>	FACTORY

Method Summary

Modifier and Type	Method	Description
UnsupportedTextMark	copy()	Returns a deep copy of this element, including copies of any nodes or marks that it contains.
String	toString()

Methods inherited from class com.atlassian.adf.model.UnsupportedElement

elementType, equals, hashCode, isSupported, toMap, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

elementType, isSupported, toMap, validate

Field Detail

FACTORY

public static final Factory<TextMark> FACTORY

Method Detail

copy

public UnsupportedTextMark 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 CodeTextMark

Specified by:

copy in interface Element

Specified by:

copy in interface FormattedTextMark

Specified by:

copy in interface Mark

Specified by:

copy in interface TextMark

Specified by:

copy in class UnsupportedElement

Returns:

a copy of this element, or this if the element is immutable anyway

toString

public String toString()

Overrides:

toString in class UnsupportedElement