org.apache.velocity.tools.plugin.taglib.model
Class Attribute

java.lang.Object
  extended by org.apache.velocity.tools.plugin.taglib.model.Attribute

@ObjectCreate(pattern="taglib/tag/attribute")
public class Attribute
extends Object

It represents a tag attribute, in a tag library descriptor.


Constructor Summary
Attribute()
           
 
Method Summary
 String getDescription()
          Returns the description of the attribute.
 String getName()
          Returns the name of the attribute.
 String getSetterName()
          Returns the name of the setter method.
 Tag getTag()
          Returns the tag that contains this attribute.
 String getType()
          Returns the type of the attribute.
 String getWrappedType()
          Returns the type that should be used in the Velocity directive for this attribute.
 boolean isRequired()
          Returns true if the attribute is required.
 boolean isRtexprvalue()
          Returns true if the attribute accepts runtime expression.
 void setDescription(String description)
          Sets the description of the attribute.
 void setJTag(Tag tag)
          Sets the tag that contains this attribute.
 void setName(String name)
          Sets the name of the attribute.
 void setRequired(boolean required)
          It tells if the attribute is required.
 void setRtexprvalue(boolean rtexprvalue)
          It tells ifthe attribute accepts runtime expression.
 void setType(String type)
          Sets the type of the attribute.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Attribute

public Attribute()
Method Detail

getName

public String getName()
Returns the name of the attribute.

Returns:
The name of the attribute.

setName

public void setName(String name)
Sets the name of the attribute.

Parameters:
name - The name of the attribute.

getDescription

public String getDescription()
Returns the description of the attribute.

Returns:
The description of the attribute.

setDescription

public void setDescription(String description)
Sets the description of the attribute.

Parameters:
description - The description of the attribute.

isRequired

public boolean isRequired()
Returns true if the attribute is required.

Returns:
true if the attribute is required.

setRequired

public void setRequired(boolean required)
It tells if the attribute is required.

Parameters:
required - true if the attribute is required.

isRtexprvalue

public boolean isRtexprvalue()
Returns true if the attribute accepts runtime expression.

Returns:
true if the attribute accepts runtime expression.

setRtexprvalue

public void setRtexprvalue(boolean rtexprvalue)
It tells ifthe attribute accepts runtime expression.

Parameters:
rtexprvalue - true if the attribute accepts runtime expression.

getType

public String getType()
Returns the type of the attribute.

Returns:
The type of the attribute.

setType

public void setType(String type)
Sets the type of the attribute.

Parameters:
type - The type of the attribute.

setJTag

@SetTop(pattern="taglib/tag/attribute")
public void setJTag(Tag tag)
Sets the tag that contains this attribute.

Parameters:
tag - The container tag.

getTag

public Tag getTag()
Returns the tag that contains this attribute.

Returns:
The container tag.

getWrappedType

public String getWrappedType()
Returns the type that should be used in the Velocity directive for this attribute.

Returns:
The type to use in Velocity directive.

getSetterName

public String getSetterName()
Returns the name of the setter method.

Returns:
The name of the setter method.

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.