org.peaseplate.internal.chunk
Class IncludeChunk

java.lang.Object
  org.peaseplate.chunk.AbstractChunk
      org.peaseplate.internal.chunk.IncludeChunk

All Implemented Interfaces:

Chunk

public final class IncludeChunk
extends AbstractChunk

Constructor Summary

IncludeChunk(TemplateLocator locator, int line, int column, java.lang.String name, ICommand[] parameterCommands)

Method Summary

java.lang.String	getName()
ICommand[]	getParameterCommands()
boolean	isEssential() Returns true if the chunk is essential, false otherwise.
boolean	isVisible() Returns true if the chunk is visible, false otherwise.
void	render(BuildContext context, java.io.Writer writer) Renders the chunk to the specified writer using the specified template context.
java.lang.String	toString() Returns a meaningful representation of this chunk

Methods inherited from class org.peaseplate.chunk.AbstractChunk

getColumn, getLine, getLocator

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeChunk

public IncludeChunk(TemplateLocator locator,
                    int line,
                    int column,
                    java.lang.String name,
                    ICommand[] parameterCommands)

Method Detail

getName

public java.lang.String getName()

getParameterCommands

public ICommand[] getParameterCommands()

isVisible

public boolean isVisible()

Description copied from interface: Chunk

Returns true if the chunk is visible, false otherwise. A content chunk with only white spaces in it, is by definition not visible and not essential. It only gets essential if it's the only thing in the line.

Returns:

true if visible, false otherwise

See Also:

Chunk.isVisible()

isEssential

public boolean isEssential()

Description copied from interface: Chunk

Returns true if the chunk is essential, false otherwise. A code chunk is by default essential, a content chunk not if it contains just spaces.

Returns:

true if essential, false otherwise

See Also:

Chunk.isEssential()

render

public void render(BuildContext context,
                   java.io.Writer writer)
            throws TemplateException,
                   java.io.IOException

Description copied from interface: Chunk

Renders the chunk to the specified writer using the specified template context.

Parameters:

context - the context

writer - the writer

Throws:

TemplateException - on occasion

java.io.IOException - on occasion

See Also:

Chunk.render(BuildContext, java.io.Writer)

toString

public java.lang.String toString()

Description copied from interface: Chunk

Returns a meaningful representation of this chunk

Specified by:

toString in interface Chunk

Overrides:

toString in class java.lang.Object

Returns:

a meaningful representation of this chunk

See Also:

Object.toString()