Package com.acrolinx.sidebar.pojo.document.externalcontent

Class ExternalContentBuilder

java.lang.Object

com.acrolinx.sidebar.pojo.document.externalcontent.ExternalContentBuilder

public class ExternalContentBuilder
extends java.lang.Object

This serves as a builder to create an object of External content

Constructor Summary

Constructors

Constructor	Description
ExternalContentBuilder()

Method Summary

Modifier and Type	Method	Description
ExternalContentBuilder	addDitaReference(ExternalContentField externalContentField)	Dita references like conref, keyref, conkeyref which represent a placeholder for external content.
ExternalContentBuilder	addDitaReference(java.lang.String id, java.lang.String content)	Dita references like conref, keyref, conkeyref which represent a placeholder for external content.
ExternalContentBuilder	addEntity(ExternalContentField externalContentField)	External content which requires parsing.
ExternalContentBuilder	addEntity(java.lang.String id, java.lang.String content)	External content which requires parsing.
ExternalContentBuilder	addTextReplacement(java.lang.String id, java.lang.String content)	External content which doesn't require parsing.
ExternalContentBuilder	addXIncludeReference(java.lang.String id, java.lang.String content)	XInclude references
ExternalContent	build()	Get the external content object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalContentBuilder

public ExternalContentBuilder()

Method Detail

addTextReplacement

public ExternalContentBuilder addTextReplacement(java.lang.String id,
                                                 java.lang.String content)

External content which doesn't require parsing.

Parameters:

id - Key of referenced entity

content - Resolved content of entity

Returns:

ExternalContentBuilder

addEntity

public ExternalContentBuilder addEntity(java.lang.String id,
                                        java.lang.String content)

External content which requires parsing.

Parameters:

id - Key of referenced entity

content - Resolved content of entity

Returns:

ExternalContentBuilder

addEntity

public ExternalContentBuilder addEntity(ExternalContentField externalContentField)

External content which requires parsing.

addDitaReference

public ExternalContentBuilder addDitaReference(java.lang.String id,
                                               java.lang.String content)

Dita references like conref, keyref, conkeyref which represent a placeholder for external content. Content will be parsed.

Parameters:

id - Key of referenced entity

content - Resolved content of entity

Returns:

ExternalContentBuilder

addDitaReference

public ExternalContentBuilder addDitaReference(ExternalContentField externalContentField)

Dita references like conref, keyref, conkeyref which represent a placeholder for external content. Content will be parsed.

addXIncludeReference

public ExternalContentBuilder addXIncludeReference(java.lang.String id,
                                                   java.lang.String content)

XInclude references

Parameters:

id - Key of referenced entity

content - Resolved content of entity

Returns:

ExternalContentBuilder

build

public ExternalContent build()

Get the external content object.

Returns:

ExternalContent