org.asciidoctor.ast

Class StructuredDocument

java.lang.Object

org.asciidoctor.ast.StructuredDocument

public class StructuredDocument
extends java.lang.Object

Structure document containing header and content chunks

Method Summary

Modifier and Type	Method and Description
static StructuredDocument	createStructuredDocument(DocumentHeader header, java.util.List<ContentPart> parts)
DocumentHeader	getHeader()
ContentPart	getPartById(java.lang.String id) Return first matched part by id
ContentPart	getPartByRole(java.lang.String role) Return first matched part by role
ContentPart	getPartByStyle(java.lang.String style) Return first matched part by style
java.util.List<ContentPart>	getParts()
java.util.List<ContentPart>	getPartsByContext(java.lang.String context) Return all parts that match specified context
java.util.List<ContentPart>	getPartsByRole(java.lang.String role) Return all parts that match specified role
java.util.List<ContentPart>	getPartsByStyle(java.lang.String style) Return all parts that match specified style

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getParts

public java.util.List<ContentPart> getParts()

getHeader

public DocumentHeader getHeader()

getPartById

public ContentPart getPartById(java.lang.String id)

Return first matched part by id

Parameters:

id - The id to match

Returns:

The ContentPart if the id is not null and the document contains a block-level element with this id or null otherwise.

getPartByStyle

public ContentPart getPartByStyle(java.lang.String style)

Return first matched part by style

Parameters:

style - The style to match

Returns:

The first ContentPart if the style is not null and the document contains a block-level element with this style name or null otherwise.

getPartByRole

public ContentPart getPartByRole(java.lang.String role)

Return first matched part by role

Parameters:

role - The role to match

Returns:

The first ContentPart if the role is not null and the document contains a block-level element with this role name or null otherwise.

getPartsByContext

public java.util.List<ContentPart> getPartsByContext(java.lang.String context)

Return all parts that match specified context

Parameters:

context - The context to match

Returns:

A list of ContentPart items that match the context if the context is not null or an empty collection.

getPartsByStyle

public java.util.List<ContentPart> getPartsByStyle(java.lang.String style)

Return all parts that match specified style

Parameters:

style - The style to match

Returns:

A list of ContentPart items that match the style if the style is not null or an empty collection.

getPartsByRole

public java.util.List<ContentPart> getPartsByRole(java.lang.String role)

Return all parts that match specified role

Parameters:

role - The role to match

Returns:

A list of ContentPart items that match the role if the role is not null or an empty collection.

createStructuredDocument

public static StructuredDocument createStructuredDocument(DocumentHeader header,
                                                          java.util.List<ContentPart> parts)