Package org.asciidoctor.ast

Interface ContentNode

All Known Subinterfaces:

Block, Cell, Column, DescriptionList, Document, List, ListItem, PhraseNode, Section, StructuralNode, Table

All Known Implementing Classes:

BlockImpl, CellImpl, ColumnImpl, ContentNodeImpl, DescriptionListEntryImpl, DescriptionListImpl, DocumentImpl, ListImpl, ListItemImpl, PhraseNodeImpl, SectionImpl, StructuralNodeImpl, TableImpl

public interface ContentNode

Method Summary

Modifier and Type	Method	Description
void	addRole(String role)
String	context()	Deprecated. Use getContext() instead.
Document	document()	Deprecated. Use getDocument() instead.
Object	getAttr(Object name)	Deprecated. Use getAttribute(Object) instead
Object	getAttr(Object name, Object defaultValue)	Deprecated. Use getAttribute(Object, Object) instead
Object	getAttr(Object name, Object defaultValue, boolean inherit)	Deprecated. Use getAttribute(Object, Object, boolean) instead
Object	getAttribute(Object name)
Object	getAttribute(Object name, Object defaultValue)
Object	getAttribute(Object name, Object defaultValue, boolean inherit)
Map<String,Object>	getAttributes()
String	getContext()
Document	getDocument()
String	getId()
String	getNodeName()
ContentNode	getParent()
String	getReftext()
String	getRole()
List<String>	getRoles()
boolean	hasAttr(Object name)	Deprecated. Use hasAttribute(Object) instead
boolean	hasAttr(Object name, boolean inherited)	Deprecated. Use hasAttribute(Object, boolean) instead
boolean	hasAttribute(Object name)
boolean	hasAttribute(Object name, boolean inherited)
boolean	hasRole(String role)
String	iconUri(String name)
String	id()	Deprecated. Please use getId()
String	imageUri(String targetImage)
String	imageUri(String targetImage, String assetDirKey)
boolean	isAttr(Object name, Object expected)	Deprecated. Use isAttribute(Object, Object) instead.
boolean	isAttr(Object name, Object expected, boolean inherit)	Deprecated. Use isAttribute(Object, Object, boolean) instead.
boolean	isAttribute(Object name, Object expected)
boolean	isAttribute(Object name, Object expected, boolean inherit)
boolean	isBlock()
boolean	isInline()
boolean	isOption(Object name)
boolean	isReftext()
boolean	isRole()
String	mediaUri(String target)
String	normalizeWebPath(String path, String start, boolean preserveUriTarget)
ContentNode	parent()	Deprecated. Use getParent() instead.
String	readAsset(String path, Map<Object,Object> opts)
void	removeRole(String role)
String	role()	Deprecated. Use getRole() instead.
boolean	setAttr(Object name, Object value, boolean overwrite)	Deprecated. Use setAttribute(Object, Object, boolean) instead.
boolean	setAttribute(Object name, Object value, boolean overwrite)
void	setId(String id)

Method Details

id

@Deprecated
String id()

Deprecated.

Please use getId()

Returns:

A unique ID for this node

getId

String getId()

Returns:

A unique ID for this node

setId

void setId(String id)

getNodeName

String getNodeName()

parent

@Deprecated
ContentNode parent()

Deprecated.

Use getParent() instead.

getParent

ContentNode getParent()

context

@Deprecated
String context()

Deprecated.

Use getContext() instead.

getContext

String getContext()

document

@Deprecated
Document document()

Deprecated.

Use getDocument() instead.

getDocument

Document getDocument()

isInline

boolean isInline()

isBlock

boolean isBlock()

getAttributes

Map<String,Object> getAttributes()

getAttr

@Deprecated
Object getAttr(Object name,
 Object defaultValue,
 boolean inherit)

Deprecated.

Use getAttribute(Object, Object, boolean) instead

Parameters:

name -

defaultValue -

inherit -

Returns:

getAttr

@Deprecated
Object getAttr(Object name,
 Object defaultValue)

Deprecated.

Use getAttribute(Object, Object) instead

Parameters:

name -

defaultValue -

Returns:

getAttr

@Deprecated
Object getAttr(Object name)

Deprecated.

Use getAttribute(Object) instead

Parameters:

name -

Returns:

getAttribute

Object getAttribute(Object name,
 Object defaultValue,
 boolean inherit)

getAttribute

Object getAttribute(Object name,
 Object defaultValue)

getAttribute

Object getAttribute(Object name)

hasAttr

@Deprecated
boolean hasAttr(Object name)

Deprecated.

Use hasAttribute(Object) instead

Parameters:

name -

Returns:

true if this node or the document has an attribute with the given name

hasAttr

@Deprecated
boolean hasAttr(Object name,
 boolean inherited)

Deprecated.

Use hasAttribute(Object, boolean) instead

Parameters:

name -

inherited -

Returns:

true if the current node or depending on the inherited parameter the document has an attribute with the given name.

hasAttribute

boolean hasAttribute(Object name)

Parameters:

name -

Returns:

true if this node or the document has an attribute with the given name

hasAttribute

boolean hasAttribute(Object name,
 boolean inherited)

Parameters:

name -

inherited -

Returns:

true if the current node or depending on the inherited parameter the document has an attribute with the given name.

isAttr

@Deprecated
boolean isAttr(Object name,
 Object expected)

Deprecated.

Use isAttribute(Object, Object) instead.

Parameters:

name -

expected -

Returns:

isAttr

@Deprecated
boolean isAttr(Object name,
 Object expected,
 boolean inherit)

Deprecated.

Use isAttribute(Object, Object, boolean) instead.

Parameters:

name -

expected -

inherit -

Returns:

isAttribute

boolean isAttribute(Object name,
 Object expected)

Parameters:

name -

expected -

Returns:

isAttribute

boolean isAttribute(Object name,
 Object expected,
 boolean inherit)

Parameters:

name -

expected -

inherit -

Returns:

setAttr

@Deprecated
boolean setAttr(Object name,
 Object value,
 boolean overwrite)

Deprecated.

Use setAttribute(Object, Object, boolean) instead.

Parameters:

name -

value -

overwrite -

Returns:

setAttribute

boolean setAttribute(Object name,
 Object value,
 boolean overwrite)

isOption

boolean isOption(Object name)

isRole

boolean isRole()

hasRole

boolean hasRole(String role)

getRole

String getRole()

role

@Deprecated
String role()

Deprecated.

Use getRole() instead.

getRoles

List<String> getRoles()

addRole

void addRole(String role)

removeRole

void removeRole(String role)

isReftext

boolean isReftext()

getReftext

String getReftext()

iconUri

String iconUri(String name)

mediaUri

String mediaUri(String target)

imageUri

String imageUri(String targetImage)

imageUri

String imageUri(String targetImage,
 String assetDirKey)

readAsset

String readAsset(String path,
 Map<Object,Object> opts)

normalizeWebPath

String normalizeWebPath(String path,
 String start,
 boolean preserveUriTarget)