org.ocltf.templateobject
Class TemplateObject

java.lang.Object
  org.ocltf.templateobject.TemplateObject

public class TemplateObject

extends java.lang.Object

Contains the configuration of a template object which can be made available to a template. Template objects are any objects that are made available to a template. Anything can be a template object, as long as it has a default public constructor.

Author:

Chad Brandon

Constructor Summary

TemplateObject()

Method Summary

void	addPropertyReference(java.lang.String reference) Adds a templateObject property reference (used to customize templateObjects)
java.lang.Object	getInstance() Returns the template object instance.
java.lang.String	getName() Gets the current name of this TemplateObjectConfig.
Plugin	getOwner() Returns the owner of this templateObject.
java.net.URL	getResource() The resource in which the templateObject was found.
void	setClassName(java.lang.String className) Sets the class of the transformation object.
void	setName(java.lang.String name) Sets the name of the transformation object (this name will be what the transformation class is stored under in the template)
void	setOwner(Plugin owner) Sets the owner of this TemplateObject.
protected void	setProperties(java.lang.Object templateObject) Sets all the properties of the templateObject object.
void	setResource(java.net.URL resource) Sets the resource in which the templateObject was found.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateObject

public TemplateObject()

Method Detail

getName

public java.lang.String getName()

Gets the current name of this TemplateObjectConfig.

Returns:

String

getInstance

public java.lang.Object getInstance()

Returns the template object instance.

Returns:

TemplateObject

setProperties

protected void setProperties(java.lang.Object templateObject)

Sets all the properties of the templateObject object.

Parameters:

templateObject -

setName

public void setName(java.lang.String name)

Sets the name of the transformation object (this name will be what the transformation class is stored under in the template)

Parameters:

name -

setClassName

public void setClassName(java.lang.String className)

Sets the class of the transformation object.

Parameters:

className -

addPropertyReference

public void addPropertyReference(java.lang.String reference)

Adds a templateObject property reference (used to customize templateObjects)

Parameters:

reference -

setOwner

public void setOwner(Plugin owner)

Sets the owner of this TemplateObject.

getOwner

public Plugin getOwner()

Returns the owner of this templateObject.

Returns:

Plugin the owner of this templateObject

getResource

public java.net.URL getResource()

The resource in which the templateObject was found.

Returns:

URL

setResource

public void setResource(java.net.URL resource)

Sets the resource in which the templateObject was found.

Parameters:

resource -

toString

public java.lang.String toString()

See Also:

Object.toString()