org.kohsuke.stapler.jelly

Class AttributeTag

java.lang.Object

org.apache.commons.jelly.TagSupport

org.kohsuke.stapler.jelly.AttributeTag

All Implemented Interfaces:

org.apache.commons.jelly.Tag

public class AttributeTag
extends org.apache.commons.jelly.TagSupport

Documentation for an attribute of a Jelly tag file.

This tag should be placed right inside <st:documentation> to describe attributes of a tag. The body would describe the meaning of an attribute in a natural language. The description text can also use Textile markup

Author:

Kohsuke Kawaguchi

Field Summary

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

body, context, parent

Constructor Summary

Constructors

Constructor and Description
AttributeTag()

Method Summary

Methods

Modifier and Type	Method and Description
void	doTag(org.apache.commons.jelly.XMLOutput output)
void	setDeprecated(boolean v) If the attribute is deprecated, set to true.
void	setName(java.lang.String v) Name of the attribute.
void	setType(java.lang.String v) If it makes sense, describe the Java type that the attribute expects as values.
void	setUse(java.lang.String v) If the attribute is required, specify use="required".

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

AttributeTag

public AttributeTag()

Method Detail

doTag

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

setName

@Required
public void setName(java.lang.String v)

Name of the attribute.

setUse

public void setUse(java.lang.String v)

If the attribute is required, specify use="required". (This is modeled after XML Schema attribute declaration.)

By default, use="optional" is assumed.

setType

public void setType(java.lang.String v)

If it makes sense, describe the Java type that the attribute expects as values.

setDeprecated

public void setDeprecated(boolean v)

If the attribute is deprecated, set to true. Use of the deprecated attribute will cause a warning.