|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.meta.info.builder.tags.AbstractTag
org.apache.avalon.meta.info.builder.tags.TypeTag
A doclet tag the declares a a Type
descriptor using the
&avalon.type
or &avalon.component
javadoc tag. The &avalon.component is senonomouse with &avalon.type.
The &avalon.type tag recognizes the following attributes:
Tag Attributes |
||
name | required | The name of the component type. |
version | optional | A version identifier in the format [major].[minor].[micro]. If not supplied the version 1.0.0 will be assumed. |
lifestyle | optional | The component implementation lifestyle - one of "singleton", "thread", "pooled", or "transient". If not supplied "transient" is assumed. |
Field Summary | |
static String |
KEY
Javadoc tag key for the type tag. |
static String |
LIFESTYLE_COLLECTION_PARAM
The lifestyle collection policy parameter |
static String |
LIFESTYLE_PARAM
The lifestyle parameter |
static String |
NAME_PARAM
The name parameter |
static String |
VERSION_PARAM
The version parameter |
Fields inherited from class org.apache.avalon.meta.info.builder.tags.AbstractTag |
TYPE_PARAM |
Constructor Summary | |
TypeTag(JavaClass clazz)
Type tag constructor. |
Method Summary | |
Type |
getType()
Return the value of the Avalon 'component' tag. |
Methods inherited from class org.apache.avalon.meta.info.builder.tags.AbstractTag |
getJavaClass, getLifecycleMethods, getNamedParameter, getNamedParameter, getNS, getNSD, resolveType, resolveVersion, resolveVersion |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String KEY
public static final String NAME_PARAM
public static final String VERSION_PARAM
public static final String LIFESTYLE_PARAM
public static final String LIFESTYLE_COLLECTION_PARAM
Constructor Detail |
public TypeTag(JavaClass clazz)
clazz
- the javadoc class descriptorMethod Detail |
public Type getType()
IllegalArgumentException
- if the name tag does not contain a value
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |