au.com.codeka.carrot.tmpl

Class Node

java.lang.Object

au.com.codeka.carrot.tmpl.Node

Direct Known Subclasses:

FixedNode, RootNode, TagNode

public abstract class Node
extends java.lang.Object

Base class for nodes in the abstract syntax tree.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Node(ResourcePointer ptr, boolean isBlockNode)

Method Summary

Modifier and Type	Method and Description
void	add(Node child) Add the given Node to our list of children.
boolean	canChain(Node node) Checks whether this Node can chain to the given node.
Node	chain(Node nextNode) Chain to the given next Node.
java.util.List<Node>	getChildren()
Node	getNextNode()
ResourcePointer	getPointer()
boolean	isBlockNode()
abstract void	render(CarrotEngine engine, java.io.Writer writer, Scope scope) Render this node to the given Writer.
void	renderChildren(CarrotEngine engine, java.io.Writer writer, Scope scope) Render all of this Node's children to the given Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Node

protected Node(ResourcePointer ptr,
               boolean isBlockNode)

Method Detail

add

public void add(Node child)

Add the given Node to our list of children. Will only be called if isBlockNode() return true.

Parameters:

child - The child Node to add.

Throws:

java.lang.IllegalStateException - if isBlockNode() returns false.

getChildren

@Nullable
public java.util.List<Node> getChildren()

Returns:

The children of this node, or null if this is not a block node.

isBlockNode

public boolean isBlockNode()

Returns:

True if this a block node (i.e. whether it should have children) or not.

canChain

public boolean canChain(Node node)

Checks whether this Node can chain to the given node.

Parameters:

node - The Node we want to check.

Returns:

True if we can chain to the following node, false if we cannot.

chain

public Node chain(Node nextNode)

Chain to the given next Node. We save the given Node as our "next" node in the chain, and then return it.

Throws:

java.lang.IllegalStateException - If you try to chain to a node where canChain(Node) returns false.

getNextNode

@Nullable
public Node getNextNode()

Returns:

The next Node in this chain, if there is one.

getPointer

public ResourcePointer getPointer()

Returns:

The ResourcePointer that point to this Node's position in the resource. Useful for logging errors and whatnot.

render

public abstract void render(CarrotEngine engine,
                            java.io.Writer writer,
                            Scope scope)
                     throws CarrotException,
                            java.io.IOException

Render this node to the given Writer.

Parameters:

engine - The CarrotEngine we're running inside of.

writer - The Writer to write this node to.

scope - The current Scope, containing all our variables.

Throws:

CarrotException - if there's an error parsing or rendering the node.

java.io.IOException - if there's an error writing to the Writer.

renderChildren

public void renderChildren(CarrotEngine engine,
                           java.io.Writer writer,
                           Scope scope)
                    throws CarrotException,
                           java.io.IOException

Render all of this Node's children to the given Writer.

Parameters:

engine - The CarrotEngine we're running inside of.

writer - The Writer to write this node to.

scope - The current Scope, containing all our variables.

Throws:

CarrotException - if there's an error parsing or rendering the node.

java.io.IOException - if there's an error writing to the Writer.