org.apache.commons.jelly.tags.util
Class PropertiesTag

java.lang.Object
  org.apache.commons.jelly.TagSupport
      org.apache.commons.jelly.tags.util.PropertiesTag

All Implemented Interfaces:

org.apache.commons.jelly.Tag

public class PropertiesTag

extends org.apache.commons.jelly.TagSupport

A tag which loads a properties file from a given file name or URI which are loaded into the current context.

Version:

$Revision: 155420 $

Author:

Jim Birchfield

Field Summary

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

body, context, hasTrimmed, parent, shouldTrim

Constructor Summary

PropertiesTag()

Method Summary

void	doTag(org.apache.commons.jelly.XMLOutput output)
void	setFile(java.lang.String file) Sets the file name to be used to load the properties file.
void	setUri(java.lang.String uri) Sets the URI of the properties file to use.
void	setVar(java.lang.String var) If this is defined then a Properties object containing all the properties will be created and exported, otherwise the current variable scope will be set to the value of the properties.

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

PropertiesTag

public PropertiesTag()

Method Detail

doTag

public void doTag(org.apache.commons.jelly.XMLOutput output)
           throws org.apache.commons.jelly.JellyTagException

Throws:

org.apache.commons.jelly.JellyTagException

setFile

public void setFile(java.lang.String file)

Sets the file name to be used to load the properties file.

setUri

public void setUri(java.lang.String uri)

Sets the URI of the properties file to use. This can be a full URL or a relative URI or an absolute URI to the root context of this JellyContext.

setVar

public void setVar(java.lang.String var)

If this is defined then a Properties object containing all the properties will be created and exported, otherwise the current variable scope will be set to the value of the properties.

Parameters:

var - The var to set