xdoclet.sdk.ant
Class AntUtil

java.lang.Object
  |
  +--xdoclet.sdk.ant.AntUtil

public class AntUtil

extends Object

Version:

$Revision: 1.9 $

Author:

Aslak Hellesøy, Erik Hatcher

Field Summary

static String

DEFAULT_CATEGORY Default category for tasks without a category attribute.

Constructor Summary

AntUtil()

Method Summary

String	displayAttributeType(XMethod method)
String	displayElementType()
String	elementName(XMethod method) Provides the element name for the current method
String	elementType() Provides the element type for the current method
static String	getCategoryName(XClass clazz) Provides the Ant category name as the Value of the category attribute.
static String	getTaskName(XClass clazz) Provides the Ant task name.
String	shortMethodDescription(XMethod method)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CATEGORY

public static final String DEFAULT_CATEGORY

Default category for tasks without a category attribute.

See Also:

Constant Field Values

Constructor Detail

AntUtil

public AntUtil()

Method Detail

getTaskName

public static final String getTaskName(XClass clazz)

Provides the Ant task name. Order of rules:

1. Value of @ant.task name="..."
2. Lowercased classname with "Task" suffix removed

Parameters:

clazz - the class to for which we're getting the task name.

Returns:

the task name

getCategoryName

public static final String getCategoryName(XClass clazz)

Provides the Ant category name as the Value of the category attribute.

Parameters:

clazz - the class to for which we're getting the category name.

Returns:

the task category name

elementName

public String elementName(XMethod method)
                   throws XDocletException

Provides the element name for the current method

Returns:

the element name

Throws:

XDocletException

displayAttributeType

public String displayAttributeType(XMethod method)
                            throws XDocletException

XDocletException

displayElementType

public String displayElementType()
                          throws XDocletException

XDocletException

elementType

public String elementType()
                   throws XDocletException

Provides the element type for the current method

Returns:

the element type (qualified class name).

Throws:

XDocletException

shortMethodDescription

public String shortMethodDescription(XMethod method)
                              throws XDocletException

XDocletException