sirius.tagliatelle.tags

Class TagHandler

java.lang.Object

sirius.tagliatelle.tags.TagHandler

Direct Known Subclasses:

ArgTag, BlockTag, DefineTag, DynamicInvokeTag, ElseTag, ForTag, IfTag, IncludeTag, InvokeTag, LocalTag, PragmaTag, RawTag, RenderTag, TaglibTagHandler

public abstract class TagHandler
extends Object

Handles a tag detected by the Compiler.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Expression>	attributes
protected Map<String,Emitter>	blocks
protected CompilationContext	compilationContext
protected TagHandler	parentHandler
protected parsii.tokenizer.Position	startOfTag
protected String	tagName

Constructor Summary

Constructors

Constructor and Description
TagHandler()

Method Summary

Modifier and Type	Method and Description
void	addBlock(String name, Emitter body) Adds a block of emitters being passed to the template.
abstract void	apply(CompositeEmitter targetBlock) Invoked when the tag is completely parsedand can be applied to the target block.
void	beforeBody() Invoked once when all attributes are parsed but before the body is compiled.
Expression	getAttribute(String name) Fetches the attribute with the given name.
Emitter	getBlock(String name) Fetches a block passed to the tag
CompilationContext	getCompilationContext() Returns the context of the current compilation.
sirius.kernel.commons.Value	getConstantAttribute(String name) Fetches the attribute with the given name, expecting that a constant value is present.
Class<?>	getExpectedAttributeType(String name) Returns the expected type for the given attribute.
TagHandler	getParentHandler() If a tag is defined within another tag, this will return the outer (parent) tag.
parsii.tokenizer.Position	getStartOfTag() Returns the position where the tag was defined.
String	getTagName() Returns the name of the tag being handled.
void	setAttribute(String name, Expression expression) Specifies an attribute.
void	setCompilationContext(CompilationContext context) Specifies the compilation context.
void	setParentHandler(TagHandler parentHandler) Specifies the handler of the enclosing tag.
void	setStartOfTag(parsii.tokenizer.Position startOfTag) Specifies the position where the tag was defined.
void	setTagName(String tagName) Specifies the name of the tag being handled.

Methods inherited from class java.lang.Object

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

Field Detail

startOfTag

protected parsii.tokenizer.Position startOfTag

compilationContext

protected CompilationContext compilationContext

parentHandler

protected TagHandler parentHandler

tagName

protected String tagName

blocks

protected Map<String,Emitter> blocks

attributes

protected Map<String,Expression> attributes

Constructor Detail

TagHandler

public TagHandler()

Method Detail

addBlock

public void addBlock(String name,
                     Emitter body)

Adds a block of emitters being passed to the template.

Parameters:

name - the name of the block

body - the emitter representing the block

See Also:

BlockTag

getBlock

@Nullable
public Emitter getBlock(@Nonnull
                                  String name)

Fetches a block passed to the tag

Parameters:

name - the name of the block to fetch

Returns:

the block or null of no such block exists

getAttribute

public Expression getAttribute(String name)

Fetches the attribute with the given name.

Parameters:

name - the name of the attribute to fetch

Returns:

the expression given for the attribute or null if the attribute is absent

getConstantAttribute

@Nonnull
public sirius.kernel.commons.Value getConstantAttribute(@Nonnull
                                                                 String name)

Fetches the attribute with the given name, expecting that a constant value is present.

Parameters:

name - the name of the attribute to fetch

Returns:

the value of the attribute wrapped as Value. If the attribute is missing, an empty value will be returned.

getExpectedAttributeType

public Class<?> getExpectedAttributeType(String name)

Returns the expected type for the given attribute.

Parameters:

name - the name of the attribute

Returns:

either a class which defines the parameter type or Expression to signal that any expression is accepted or null to indicate that the parameter is unexpected.

setAttribute

public void setAttribute(String name,
                         Expression expression)

Specifies an attribute.

Parameters:

name - the name of the attribute

expression - the expression for the attribute

getStartOfTag

public parsii.tokenizer.Position getStartOfTag()

Returns the position where the tag was defined.

Returns:

the position where the tag was defined

setStartOfTag

public void setStartOfTag(parsii.tokenizer.Position startOfTag)

Specifies the position where the tag was defined.

Parameters:

startOfTag - the position where the tag started.

getCompilationContext

public CompilationContext getCompilationContext()

Returns the context of the current compilation.

Returns:

the context, mostly used for error reporting

setCompilationContext

public void setCompilationContext(CompilationContext context)

Specifies the compilation context.

Parameters:

context - the current compilation context

getParentHandler

@Nullable
public TagHandler getParentHandler()

If a tag is defined within another tag, this will return the outer (parent) tag.

Returns:

the handler of the enclosing tag

setParentHandler

public void setParentHandler(TagHandler parentHandler)

Specifies the handler of the enclosing tag.

Parameters:

parentHandler - the handler of the enclosing tag

getTagName

public String getTagName()

Returns the name of the tag being handled.

Returns:

the name of the tag

setTagName

public void setTagName(String tagName)

Specifies the name of the tag being handled.

Parameters:

tagName - the name of the tag

beforeBody

public void beforeBody()

Invoked once when all attributes are parsed but before the body is compiled.

apply

public abstract void apply(CompositeEmitter targetBlock)

Invoked when the tag is completely parsedand can be applied to the target block.

Parameters:

targetBlock - the outer block to which the output can be appended