org.apache.avalon.meta.info.builder.tags
Class TypeTag

java.lang.Object
  extended byorg.apache.avalon.meta.info.builder.tags.AbstractTag
      extended byorg.apache.avalon.meta.info.builder.tags.TypeTag

public class TypeTag
extends AbstractTag

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

namerequired The name of the component type.
versionoptional A version identifier in the format [major].[minor].[micro]. If not supplied the version 1.0.0 will be assumed.
lifestyleoptional The component implementation lifestyle - one of "singleton", "thread", "pooled", or "transient". If not supplied "transient" is assumed.

Version:
$Revision: 1.4 $ $Date: 2003/10/19 06:09:32 $
Author:
Avalon Development Team

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

KEY

public static final String KEY
Javadoc tag key for the type tag.

See Also:
Constant Field Values

NAME_PARAM

public static final String NAME_PARAM
The name parameter

See Also:
Constant Field Values

VERSION_PARAM

public static final String VERSION_PARAM
The version parameter

See Also:
Constant Field Values

LIFESTYLE_PARAM

public static final String LIFESTYLE_PARAM
The lifestyle parameter

See Also:
Constant Field Values

LIFESTYLE_COLLECTION_PARAM

public static final String LIFESTYLE_COLLECTION_PARAM
The lifestyle collection policy parameter

See Also:
Constant Field Values
Constructor Detail

TypeTag

public TypeTag(JavaClass clazz)
Type tag constructor.

Parameters:
clazz - the javadoc class descriptor
Method Detail

getType

public Type getType()
Return the value of the Avalon 'component' tag.

Returns:
the name of the component type
Throws:
IllegalArgumentException - if the name tag does not contain a value


Copyright © Apache Software Foundation. All Rights Reserved.