Package org.apache.commons.jelly.tags.core

Class FileTag

java.lang.Object

org.apache.commons.jelly.TagSupport

org.apache.commons.jelly.tags.core.FileTag

All Implemented Interfaces:

Tag

public class FileTag
extends TagSupport

A tag that pipes its body to a file denoted by the name attribute or to an in memory String which is then output to a variable denoted by the var variable.

Author:

Vinay Chandran

Field Summary

Fields inherited from class org.apache.commons.jelly.TagSupport

body, context, parent

Constructor Summary

Constructors

Constructor	Description
FileTag()

Method Summary

Modifier and Type	Method	Description
protected XMLOutput	createXMLOutput(Writer writer)	A Factory method to create a new XMLOutput from the given Writer.
void	doTag(XMLOutput output)	Evaluates this tag after all the tags properties have been initialized.
String	getVar()	Returns the var.
void	setAppend(boolean doAppend)	Sets wether to append at the end of the file (not really something you normally do with an XML file).
void	setEncoding(String encoding)	Sets the XML encoding mode, which defaults to UTF-8
void	setName(String name)	Sets the file name for the output
void	setOmitXmlDeclaration(boolean omitXmlDeclaration)	Sets whether the XML declaration should be output or not
void	setOutputMode(String outputMode)	Sets the output mode, whether XML or HTML
void	setPrettyPrint(boolean prettyPrint)	Sets whether pretty printing mode is turned on.
void	setVar(String var)	Sets the var.
protected void	writeBody(Writer writer)	Writes the body fo this tag to the given Writer

Methods inherited from class org.apache.commons.jelly.TagSupport

findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTag

public FileTag()

Method Detail

doTag

public void doTag(XMLOutput output)
           throws JellyTagException

Description copied from interface: Tag

Evaluates this tag after all the tags properties have been initialized.

Throws:

JellyTagException

setName

public void setName(String name)

Sets the file name for the output

setOmitXmlDeclaration

public void setOmitXmlDeclaration(boolean omitXmlDeclaration)

Sets whether the XML declaration should be output or not

setOutputMode

public void setOutputMode(String outputMode)

Sets the output mode, whether XML or HTML

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Sets whether pretty printing mode is turned on. The default is off so that whitespace is preserved

setEncoding

public void setEncoding(String encoding)

Sets the XML encoding mode, which defaults to UTF-8

setAppend

public void setAppend(boolean doAppend)

Sets wether to append at the end of the file (not really something you normally do with an XML file).

getVar

public String getVar()

Returns the var.

Returns:

String

setVar

public void setVar(String var)

Sets the var.

Parameters:

var - The var to set

writeBody

protected void writeBody(Writer writer)
                  throws SAXException,
                         JellyTagException

Writes the body fo this tag to the given Writer

Throws:

SAXException

JellyTagException

createXMLOutput

protected XMLOutput createXMLOutput(Writer writer)

A Factory method to create a new XMLOutput from the given Writer.