antsnest.antinfo
Interface Definition

All Known Subinterfaces:

TaskDefinition, TypeDefinition

All Known Implementing Classes:

DefaultTaskDefinition, DefaultTypeDefinition

public interface Definition

How both tasks and types should be defined

Author:

Chris Clohosy

Method Summary

AttributeDefinition	getAttribute(String name) Gets an attribute by name
AttributeDefinition[]	getAttributes() Gets all the attributes belonging to this type/task
String	getClassname() Gets the classname of this task/type
String	getName() Gets the name of this task/type
TypeDefinition	getNestedElement(String name) Gets a nested element by name
TypeDefinition[]	getNestedElements() Gets all the nested elements this task/type accepts
boolean	isDeprecated() Whether this task/type is deprecated

Method Detail

isDeprecated

boolean isDeprecated()

Whether this task/type is deprecated

Returns:

a boolean, whether it is deprecated

getName

String getName()

Gets the name of this task/type

Returns:

a String, the name

getClassname

String getClassname()

Gets the classname of this task/type

Returns:

a String, the classname

getAttributes

AttributeDefinition[] getAttributes()

Gets all the attributes belonging to this type/task

Returns:

an AttributeDefinition[], the attributes

getNestedElements

TypeDefinition[] getNestedElements()

Gets all the nested elements this task/type accepts

Returns:

a TypeDefinition[], the elements

getAttribute

AttributeDefinition getAttribute(String name)

Gets an attribute by name

Parameters:

name - the name of the attribute to get

Returns:

an AttributeDefinition, the attribute

getNestedElement

TypeDefinition getNestedElement(String name)

Gets a nested element by name

Parameters:

name - the name of the element to get

Returns:

a TypeDefinition, the nested element