Package com.atlassian.adf.model.mark

Class DataConsumer

java.lang.Object

com.atlassian.adf.model.mark.DataConsumer

All Implemented Interfaces:

Element, Mark, BodiedExtensionMark, ExtensionMark, InlineExtensionMark

@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class DataConsumer
extends Object
implements BodiedExtensionMark, ExtensionMark, InlineExtensionMark

Its purpose seems to be related to giving extension nodes a way to specify that an extension will want access to the data supplied by the given data sources on the page, presumably so that it can render them nicely for the end user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataConsumer.Partial	Types that represent a partially constructed dataConsumer.

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
DataConsumer	copy()	Returns a deep copy of this element, including copies of any nodes or marks that it contains.
static DataConsumer.Partial.NeedsSource	dataConsumer()
static DataConsumer	dataConsumer(Iterable<String> sources)
static DataConsumer	dataConsumer(String source)
static DataConsumer	dataConsumer(String... sources)
static DataConsumer	dataConsumer(Stream<String> sources)
String	elementType()	The type value that identifies this element, such as "paragraph" or "strong".
boolean	equals(Object o)
int	hashCode()
boolean	isSupported()	Indicates whether this element is fully supported by this library.
protected FieldMap	mapWithType()
DataConsumer	source(String source)
Set<String>	sources()
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()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isSupported

Method Detail

dataConsumer

public static DataConsumer.Partial.NeedsSource dataConsumer()

dataConsumer

public static DataConsumer dataConsumer(String source)

dataConsumer

public static DataConsumer dataConsumer(String... sources)

dataConsumer

public static DataConsumer dataConsumer(Iterable<String> sources)

dataConsumer

public static DataConsumer dataConsumer(Stream<String> sources)

copy

public DataConsumer 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 BodiedExtensionMark

Specified by:

copy in interface Element

Specified by:

copy in interface ExtensionMark

Specified by:

copy in interface InlineExtensionMark

Specified by:

copy in interface Mark

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

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

source

public DataConsumer source(String source)

sources

public Set<String> sources()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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