Package com.atlassian.adf.model.node

Class EmbedCard

java.lang.Object

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

com.atlassian.adf.model.node.EmbedCard

All Implemented Interfaces:

Element, Node, DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent

@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class EmbedCard
extends AbstractNode<EmbedCard>
implements DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EmbedCard.Partial	Types that represent a partially constructed embedCard.

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

Method Summary

Modifier and Type	Method	Description
EmbedCard	alignEnd()
EmbedCard	alignStart()
protected void	appendNodeFields(AbstractNode.ToStringHelper buf)	Allows nodes that have their own fields to augment the toString() implementation with their own field values.
EmbedCard	center()
EmbedCard	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".
static EmbedCard.Partial.NeedsLayout	embedCard()
static EmbedCard.Partial.NeedsUrl	embedCard(RichMedia.Layout layout)
static EmbedCard	embedCard(RichMedia.Layout layout, URI url)
static EmbedCard	embedCard(RichMedia.Layout layout, URL url)
static EmbedCard.Partial.NeedsUrl	embedCard(String layout)
EmbedCard	fullWidth()
RichMedia.Layout	layout()
EmbedCard	layout(RichMedia.Layout layout)
EmbedCard	layout(String layout)
protected boolean	nodeEquals(EmbedCard other)	Allows nodes that have their own fields to augment the equals implementation with tests for their own field values.
protected int	nodeHashCode()	Allows nodes that have their own fields to augment the hashCode implementation with a hash of their own field values.
Optional<Number>	originalHeight()
EmbedCard	originalHeight(Number originalHeight)
EmbedCard	originalSize(Number originalWidth, Number originalHeight)
Optional<Number>	originalWidth()
EmbedCard	originalWidth(Number originalWidth)
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	url()
EmbedCard	url(String url)
EmbedCard	url(URI url)
EmbedCard	url(URL url)
void	validate()	Verifies that the node is well-formed (including the state of any descendents that it has).
EmbedCard	wide()
Optional<Number>	width()
EmbedCard	width(Number width)
EmbedCard	wrapLeft()
EmbedCard	wrapRight()

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

appendPlainText, 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.Element

isSupported

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

appendPlainText, toPlainText

Method Detail

embedCard

public static EmbedCard embedCard(RichMedia.Layout layout,
                                  URL url)

embedCard

public static EmbedCard embedCard(RichMedia.Layout layout,
                                  URI url)

embedCard

public static EmbedCard.Partial.NeedsLayout embedCard()

embedCard

public static EmbedCard.Partial.NeedsUrl embedCard(String layout)

embedCard

public static EmbedCard.Partial.NeedsUrl embedCard(RichMedia.Layout layout)

layout

public RichMedia.Layout layout()

layout

public EmbedCard layout(String layout)

layout

public EmbedCard layout(RichMedia.Layout layout)

wide

public EmbedCard wide()

fullWidth

public EmbedCard fullWidth()

center

public EmbedCard center()

wrapRight

public EmbedCard wrapRight()

wrapLeft

public EmbedCard wrapLeft()

alignEnd

public EmbedCard alignEnd()

alignStart

public EmbedCard alignStart()

url

public String url()

url

public EmbedCard url(String url)

url

public EmbedCard url(URL url)

url

public EmbedCard url(URI url)

originalWidth

public EmbedCard originalWidth(Number originalWidth)

originalWidth

public Optional<Number> originalWidth()

originalHeight

public EmbedCard originalHeight(Number originalHeight)

originalHeight

public Optional<Number> originalHeight()

width

public EmbedCard width(@Nullable
                       Number width)

width

public Optional<Number> width()

originalSize

public EmbedCard originalSize(Number originalWidth,
                              Number originalHeight)

copy

public EmbedCard 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 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

nodeEquals

protected boolean nodeEquals(EmbedCard other)

Description copied from class: AbstractNode

Allows 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 the AbstractNode.equals(Object) implementation that 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 AbstractNode should maintain consistent implementations of nodeHashCode, nodeEquals, and appendNodeFields.

Overrides:

nodeEquals in class AbstractNode<EmbedCard>

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:

AbstractNode.nodeHashCode(), AbstractNode.appendNodeFields(ToStringHelper)

nodeHashCode

protected int nodeHashCode()

Description copied from class: AbstractNode

Allows 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 the AbstractNode.hashCode() implementation that 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 AbstractNode should maintain consistent implementations of nodeHashCode, nodeEquals, and appendNodeFields.

Overrides:

nodeHashCode in class AbstractNode<EmbedCard>

Returns:

the hash code of any additional field values that belong to a particular type of content node.

See Also:

AbstractNode.nodeEquals(AbstractNode), AbstractNode.appendNodeFields(ToStringHelper)

appendNodeFields

protected void appendNodeFields(AbstractNode.ToStringHelper buf)

Description copied from class: AbstractNode

Allows 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 AbstractNode should maintain consistent implementations of nodeHashCode, nodeEquals, and appendNodeFields.

Overrides:

appendNodeFields in class AbstractNode<EmbedCard>

Parameters:

buf - where the field values should be written

See Also:

AbstractNode.nodeHashCode(), AbstractNode.nodeEquals(AbstractNode)

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

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