Package com.atlassian.adf.model.node

Class Blockquote

java.lang.Object

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

com.atlassian.adf.model.node.AbstractContentNode<Blockquote,Paragraph>

com.atlassian.adf.model.node.Blockquote

All Implemented Interfaces:

Element, Node, ContentNode<Blockquote,Paragraph>, DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent

public class Blockquote
extends AbstractContentNode<Blockquote,Paragraph>
implements DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent

The Blockquote node is a container for quotes. At least one Paragraph must be provided as the block's content.

Example

Java

 bq(
         p("Hello world"),
         p("\u2014 Atlassian Document Format")
 );
 

ADF

   {
     "type": "blockquote",
     "content": [
       {
         "type": "paragraph",
         "content": [
           {
             "type": "text",
             "text": "Hello world"
           }
         ]
       },
       {
         "type": "paragraph",
         "content": [
           {
             "type": "text",
             "text": "— Atlassian Document Format"
           }
         ]
       }
     ]
   }
 

Result

Hello, world

— Atlassian Document Format

See Also:

Node - blockquote

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.AbstractContentNode

content

Method Summary

Modifier and Type	Method	Description
void	appendPlainText(StringBuilder sb)	Renders this node as plain-text suitable for viewing by end users.
static Blockquote	blockquote()
static Blockquote	blockquote(Paragraph content)
static Blockquote	blockquote(Paragraph... content)
static Blockquote	blockquote(Iterable<? extends Paragraph> content)
static Blockquote	blockquote(String content)
static Blockquote	blockquote(String... content)
static Blockquote	blockquote(Stream<? extends Paragraph> content)
static Blockquote	bq()	Create an empty Blockquote node.
static Blockquote	bq(Paragraph content)	Create a Blockquote node containing a single paragraph as its content.
static Blockquote	bq(Paragraph... content)	Create a Blockquote node containing the given paragraph as its content.
static Blockquote	bq(Iterable<? extends Paragraph> content)	Create a Blockquote node containing the given paragraph as its content.
static Blockquote	bq(String content)	Create a Blockquote node containing a single paragraph with the given text as its content.
static Blockquote	bq(String... content)	Create a Blockquote node containing a single paragraph with the given text as its content.
static Blockquote	bq(Stream<? extends Paragraph> content)	Create a Blockquote node containing the given paragraph as its content.
Class<Paragraph>	contentClass()	Returns Class<N>, the class representing the type of items held by this node.
protected void	contentNodeValidate()
Blockquote	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".
Map<String,?>	toMap()	Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
protected void	validateContentNodeForAppend(Paragraph node)	Called on each content node before it is added to validate that the node can be accepted.

Methods inherited from class com.atlassian.adf.model.node.AbstractContentNode

addContent, addContentIfPresent, allNodes, appendContentNodeFields, appendNodeFields, appendPlainTextContentJoinedWith, appendPlainTextInlineContent, clear, content, content, content, content, content, contentFieldMaps, contentNodeEquals, contentNodeHashCode, isEmpty, nodeEquals, nodeHashCode, parseContentItem, parseContentItems, parseOptionalContent, parseRequiredContent, parseRequiredContentAllowEmpty, removeIf, replaceContent, requireNotEmpty, transformContent, transformDescendants, trim, validate, validateContentItems

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

allNodesOfType, allNodesOfTypeAsList

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

isSupported, validate

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

toPlainText

Method Detail

contentClass

public Class<Paragraph> contentClass()

Description copied from interface: ContentNode

Returns Class<N>, the class representing the type of items held by this node.

Specified by:

contentClass in interface ContentNode<Blockquote,Paragraph>

bq

public static Blockquote bq()

Create an empty Blockquote node. At least one Paragraph must be provided as the block's content to make it valid.

Returns:

a new, empty Blockquote

bq

public static Blockquote bq(String content)

Create a Blockquote node containing a single paragraph with the given text as its content.

Parameters:

content - the string to use as the content of the block quote. As a convenience, the provided string is wrapped first as a Text node and then as a Paragraph before it is set as the content. It cannot be an empty string.

Returns:

a new Blockquote containing the provided text as its content

bq

public static Blockquote bq(String... content)

Create a Blockquote node containing a single paragraph with the given text as its content. As a convenience, each element of content is wrapped first as a Text node and then as a Paragraph before it is set as the content for this Blockquote.

At least one Paragraph must be provided as the block's content to make it valid.

Parameters:

content - the strings to use as the content of the block quote. As a convenience, each provided string is wrapped first as a Text node and then as a Paragraph before it is set as the content, so each element will form its own paragraph. None of them may be an empty string.

Returns:

a new Blockquote containing the provided text as its content

bq

public static Blockquote bq(Paragraph content)

Create a Blockquote node containing a single paragraph as its content.

Parameters:

content - the paragraph to use as the content of the block quote.

Returns:

a new Blockquote containing the provided paragraph as its content

bq

public static Blockquote bq(Paragraph... content)

Create a Blockquote node containing the given paragraph as its content. At least one Paragraph must be provided as the block's content to make it valid.

Parameters:

content - the paragraphs to use as the content of the block quote.

Returns:

a new Blockquote containing the provided paragraph as its content

bq

public static Blockquote bq(Iterable<? extends Paragraph> content)

Create a Blockquote node containing the given paragraph as its content. At least one Paragraph must be provided as the block's content to make it valid.

Parameters:

content - the paragraphs to use as the content of the block quote. The iterable will be iterated at most once and immediately.

Returns:

a new Blockquote containing the provided paragraph as its content

bq

public static Blockquote bq(Stream<? extends Paragraph> content)

Create a Blockquote node containing the given paragraph as its content. At least one Paragraph must be provided as the block's content to make it valid.

Parameters:

content - the paragraphs to use as the content of the block quote. The stream will be terminated and consumed immediately.

Returns:

a new Blockquote containing the provided paragraph as its content

blockquote

public static Blockquote blockquote()

See Also:

bq()

blockquote

public static Blockquote blockquote(String content)

See Also:

bq(String)

blockquote

public static Blockquote blockquote(String... content)

See Also:

bq(String[])

blockquote

public static Blockquote blockquote(Paragraph content)

See Also:

bq(Paragraph)

blockquote

public static Blockquote blockquote(Paragraph... content)

See Also:

bq(Paragraph[])

blockquote

public static Blockquote blockquote(Iterable<? extends Paragraph> content)

See Also:

bq(Iterable)

blockquote

public static Blockquote blockquote(Stream<? extends Paragraph> content)

See Also:

bq(Stream)

copy

public Blockquote 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 ContentNode<Blockquote,Paragraph>

Specified by:

copy in interface Element

Specified by:

copy in interface Node

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

contentNodeValidate

protected void contentNodeValidate()

Overrides:

contentNodeValidate in class AbstractContentNode<Blockquote,Paragraph>

validateContentNodeForAppend

protected void validateContentNodeForAppend(Paragraph node)

Description copied from class: AbstractContentNode

Called on each content node before it is added to validate that the node can be accepted.

Overrides:

validateContentNodeForAppend in class AbstractContentNode<Blockquote,Paragraph>

Parameters:

node - the node that is about to be added

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

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 AbstractContentNode<Blockquote,Paragraph>

Parameters:

sb - where to write the result