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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addRole(java.lang.String role)
java.lang.Object
getAttribute(java.lang.Object name)
java.lang.Object
getAttribute(java.lang.Object name, java.lang.Object defaultValue)
java.lang.Object
getAttribute(java.lang.Object name, java.lang.Object defaultValue, boolean inherit)
java.util.Map<java.lang.String,java.lang.Object>
getAttributes()
java.lang.String
getContext()
Document
getDocument()
java.lang.String
getId()
java.lang.String
getNodeName()
ContentNode
getParent()
java.lang.String
getReftext()
java.lang.String
getRole()
java.util.List<java.lang.String>
getRoles()
boolean
hasAttribute(java.lang.Object name)
boolean
hasAttribute(java.lang.Object name, boolean inherited)
boolean
hasRole(java.lang.String role)
java.lang.String
iconUri(java.lang.String name)
java.lang.String
imageUri(java.lang.String targetImage)
java.lang.String
imageUri(java.lang.String targetImage, java.lang.String assetDirKey)
boolean
isAttribute(java.lang.Object name, java.lang.Object expected)
boolean
isAttribute(java.lang.Object name, java.lang.Object expected, boolean inherit)
boolean
isBlock()
boolean
isInline()
boolean
isOption(java.lang.Object name)
boolean
isReftext()
boolean
isRole()
java.lang.String
mediaUri(java.lang.String target)
java.lang.String
normalizeWebPath(java.lang.String path, java.lang.String start, boolean preserveUriTarget)
java.lang.String
readAsset(java.lang.String path, java.util.Map<java.lang.Object,java.lang.Object> opts)
void
removeRole(java.lang.String role)
boolean
setAttribute(java.lang.Object name, java.lang.Object value, boolean overwrite)
void
setContext(java.lang.String context)
void
setId(java.lang.String id)
-
-
-
Method Detail
-
getId
java.lang.String getId()
- Returns:
- A unique ID for this node
-
setId
void setId(java.lang.String id)
-
getNodeName
java.lang.String getNodeName()
-
getParent
ContentNode getParent()
-
getContext
java.lang.String getContext()
-
setContext
void setContext(java.lang.String context)
-
getDocument
Document getDocument()
-
isInline
boolean isInline()
-
isBlock
boolean isBlock()
-
getAttributes
java.util.Map<java.lang.String,java.lang.Object> getAttributes()
-
getAttribute
java.lang.Object getAttribute(java.lang.Object name, java.lang.Object defaultValue, boolean inherit)
-
getAttribute
java.lang.Object getAttribute(java.lang.Object name, java.lang.Object defaultValue)
-
getAttribute
java.lang.Object getAttribute(java.lang.Object name)
-
hasAttribute
boolean hasAttribute(java.lang.Object name)
- Parameters:
name
-- Returns:
true
if this node or the document has an attribute with the given name
-
hasAttribute
boolean hasAttribute(java.lang.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.
-
isAttribute
boolean isAttribute(java.lang.Object name, java.lang.Object expected)
- Parameters:
name
-expected
-- Returns:
-
isAttribute
boolean isAttribute(java.lang.Object name, java.lang.Object expected, boolean inherit)
- Parameters:
name
-expected
-inherit
-- Returns:
-
setAttribute
boolean setAttribute(java.lang.Object name, java.lang.Object value, boolean overwrite)
- Parameters:
name
-value
-overwrite
-- Returns:
-
isOption
boolean isOption(java.lang.Object name)
-
isRole
boolean isRole()
-
hasRole
boolean hasRole(java.lang.String role)
-
getRole
java.lang.String getRole()
-
getRoles
java.util.List<java.lang.String> getRoles()
-
addRole
void addRole(java.lang.String role)
-
removeRole
void removeRole(java.lang.String role)
-
isReftext
boolean isReftext()
-
getReftext
java.lang.String getReftext()
-
iconUri
java.lang.String iconUri(java.lang.String name)
-
mediaUri
java.lang.String mediaUri(java.lang.String target)
-
imageUri
java.lang.String imageUri(java.lang.String targetImage)
-
imageUri
java.lang.String imageUri(java.lang.String targetImage, java.lang.String assetDirKey)
-
readAsset
java.lang.String readAsset(java.lang.String path, java.util.Map<java.lang.Object,java.lang.Object> opts)
-
normalizeWebPath
java.lang.String normalizeWebPath(java.lang.String path, java.lang.String start, boolean preserveUriTarget)
-
-