Package com.atlassian.adf.model.mark

Class Underline

java.lang.Object

com.atlassian.adf.model.mark.Underline

All Implemented Interfaces:

Element, Mark, FormattedTextMark, TextMark

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

The underline mark sets underline styling. This mark applies to Text nodes and can only be combined with other formatted-text marks.

Example

Java

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

ADF

   {
     "type": "paragraph",
     "content": [
       {
         "type": "text",
         "text": "Hello "
       },
       {
         "type": "text",
         "text": "world",
         "marks": [
           {
             "type": "underline"
           }
         ]
       },
       {
         "type": "text",
         "text": "!"
       }
     ]
   }
 

Result

Hello world!

See Also:

Mark - underline

Nested Class Summary

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, Mark.Type

Method Summary

Modifier and Type	Method	Description
Underline	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	isSupported()	Indicates whether this element is fully supported by this library.
protected FieldMap	mapWithType()
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()
static Underline	underline()
static Text	underline(Text text)	Convenience method for applying an underline mark to an existing text node.
static Text	underline(String text)	Convenience method for constructing a text node with an underline mark.
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, toMap, validate

Method Detail

underline

public static Underline underline()

Returns:

an underline mark

underline

public static Text underline(String text)

Convenience method for constructing a text node with an underline mark.

Parameters:

text - the text to mark

Returns:

the resulting marked text node

underline

public static Text underline(Text text)

Convenience method for applying an underline 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 Underline 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

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

mapWithType

protected FieldMap mapWithType()

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

Overrides:

toString in class Object

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