Package com.atlassian.adf.model.mark

Class SubSup

java.lang.Object

com.atlassian.adf.model.mark.SubSup

All Implemented Interfaces:

Element, Mark, FormattedTextMark, TextMark

@Documentation(state=REVIEWED,
               date="2023-07-26")
@Immutable
public class SubSup
extends Object
implements FormattedTextMark

The subsup mark sets ^superscript or _subscript styling. This mark applies to Text nodes and can only be combined with other formatted-text marks.

Example

Java

 p(
         text("Hello "),
         text("world").sup(),
         text("!")
 );
 

ADF

   {
     "type": "paragraph",
     "content": [
       {
         "type": "text",
         "text": "Hello "
       },
       {
         "type": "text",
         "text": "world",
         "marks": [
           {
             "type": "subsup",
             "attrs": {
               "type": "sup"
             }
           }
         ]
       },
       {
         "type": "text",
         "text": "!"
       }
     ]
   }
 

Result

Hello ^world!

See Also:

Mark - subsup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubSup.Type

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

Element.Key

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

Mark.Attr

Method Summary

Modifier and Type	Method	Description
SubSup	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".
boolean	isSub()
boolean	isSup()
boolean	isSupported()	Indicates whether this element is fully supported by this library.
protected FieldMap	mapWithType()
static SubSup	sub()
static Text	sub(Text text)	Convenience method for applying a sub mark to an existing text node.
static Text	sub(String text)	Convenience method for constructing a text node with a sub mark.
static SubSup	sup()
static Text	sup(Text text)	Convenience method for applying a sup mark to an existing text node.
static Text	sup(String text)	Convenience method for constructing a text node with a sup mark.
Map<String,?>	toMap()	Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
String	toString()
SubSup.Type	type()
void	validate()	Verifies that the node is well-formed (including the state of any descendents that it has).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isSupported, validate

Method Detail

sub

public static SubSup sub()

Returns:

a subsup mark for _subscript text

sub

public static Text sub(String text)

Convenience method for constructing a text node with a sub mark.

Parameters:

text - the text to mark

Returns:

the resulting marked text node

sub

public static Text sub(Text text)

Convenience method for applying a sub mark to an existing text node.

Parameters:

text - the text to mark

Returns:

the resulting marked text node

Throws:

AdfException - if it isn't possible to apply that mark to the existing text node

sup

public static SubSup sup()

Returns:

a subsup mark for ^superscript text

sup

public static Text sup(String text)

Convenience method for constructing a text node with a sup mark.

Parameters:

text - the text to mark

Returns:

the resulting marked text node

sup

public static Text sup(Text text)

Convenience method for applying a sup mark to an existing text node.

Parameters:

text - the text to mark

Returns:

the resulting marked text node

Throws:

AdfException - if it isn't possible to apply that mark to the existing text node

copy

public SubSup 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 FormattedTextMark

Specified by:

copy in interface Mark

Specified by:

copy in interface TextMark

Returns:

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

isSub

public boolean isSub()

isSup

public boolean isSup()

type

public SubSup.Type type()

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

toString

public String toString()

mapWithType

protected FieldMap mapWithType()

isSupported

public boolean isSupported()

Description copied from interface: Element

Indicates whether this element is fully supported by this library. This library includes a small amount of support for preserving new, unrecognized node types during a round trip. These are represented by immutable placeholder objects that return false for this value.

Specified by:

isSupported in interface Element

Returns:

true for fully supported elements; false for immutable placeholders

validate

public void validate()

Description copied from interface: Element

Verifies that the node is well-formed (including the state of any descendents that it has).

Specified by:

validate in interface Element