com.tridion.tcdl

Class TransformContextFactory

java.lang.Object

com.tridion.tcdl.TransformContextFactory

public class TransformContextFactory
extends Object

Creates TransformContext needed for Tag processing. It allows to create instances of scoped TransformContext based on the argument provided.

Note that, if enclosing context is not provided, it utilizes nullContext as a default enclosing context.

Constructor Summary

Constructors

Constructor and Description
TransformContextFactory()

Method Summary

Modifier and Type	Method and Description
static TransformContext	newInstance(String codeBlockStartMarker, String codeBlockEndMarker) Instantiates an instance of TransformContext using the given markers for inline code blocks.
static TransformContext	newInstance(String codeBlockStartMarker, String codeBlockEndMarker, Map configurationProperties, Map<String,String> renderParameters) Instantiates a new instance of TransformContext using the given markers for inline code blocks and with the internal properties set from the configurationProperties
static TransformContext	newInstance(String codeBlockStartMarker, String codeBlockEndMarker, Map configurationProperties, Map<String,String> renderParameters, TransformContext enclosingContext) Instantiates a new instance of TransformContext using the given markers for inline code blocks and with the internal properties set from the configurationProperties.
static TransformContext	newInstance(String codeBlockStartMarker, String codeBlockEndMarker, TransformContext enclosingContext) Instantiates an instance of TransformContext using the given markers for inline code blocks.
static TransformContext	newInstance(TransformContext enclosingContext) Instantiates an instance of TransformContext using the default markers for inline code blocks.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformContextFactory

public TransformContextFactory()

Method Detail

newInstance

public static TransformContext newInstance(String codeBlockStartMarker,
                                           String codeBlockEndMarker,
                                           Map configurationProperties,
                                           Map<String,String> renderParameters,
                                           TransformContext enclosingContext)

Instantiates a new instance of TransformContext using the given markers for inline code blocks and with the internal properties set from the configurationProperties.

Parameters:

codeBlockStartMarker - marker to start an inline code block

codeBlockEndMarker - marker to end an inline code block

configurationProperties - properties to inherit

renderParameters - the rendering parameters to be used during rendering of content

enclosingContext - enclosing context i.e., context of its enclosing Tag in active tag hierarchy.

Returns:

an instance of TransformContext

Throws:

IllegalArgumentException - if enclosingContext is null.

newInstance

public static TransformContext newInstance(String codeBlockStartMarker,
                                           String codeBlockEndMarker,
                                           TransformContext enclosingContext)

Instantiates an instance of TransformContext using the given markers for inline code blocks.

Parameters:

codeBlockStartMarker - marker to start an inline code block

codeBlockEndMarker - marker to end an inline code block

enclosingContext - enclosing context i.e., context of its enclosing Tag in active tag hierarchy.

Returns:

an instance of TransformContext

Throws:

IllegalArgumentException - if enclosingContext is null.

newInstance

public static TransformContext newInstance(TransformContext enclosingContext)

Instantiates an instance of TransformContext using the default markers for inline code blocks. In addition, it sets enclosingContext as the enclosing context of the newly created content.

Returns:

an instance of TransformContext

Throws:

IllegalArgumentException - if enclosingContext is null.

newInstance

public static TransformContext newInstance(String codeBlockStartMarker,
                                           String codeBlockEndMarker,
                                           Map configurationProperties,
                                           Map<String,String> renderParameters)

Instantiates a new instance of TransformContext using the given markers for inline code blocks and with the internal properties set from the configurationProperties

It, in essence, constructs a global (alternatively, can be denoted as root) TransformContext, which is active during a particular transformation (deployment or runtime) phase.

Parameters:

codeBlockStartMarker - marker to start an inline code block

codeBlockEndMarker - marker to end an inline code block

configurationProperties - properties to inherit

renderParameters - the rendering parameters to be used during rendering of content

Returns:

an instance of TransformContext

newInstance

public static TransformContext newInstance(String codeBlockStartMarker,
                                           String codeBlockEndMarker)

Instantiates an instance of TransformContext using the given markers for inline code blocks. It, in essence, constructs a global TransformContext, which is active during a particular transformation (deployment or runtime) phase.

Parameters:

codeBlockStartMarker - marker to start an inline code block

codeBlockEndMarker - marker to end an inline code block

Returns:

an instance of TransformContext