antsnest.antinfo
Interface AntInfo

All Known Implementing Classes:

DefaultAntInfo

public interface AntInfo

The object responsible for providing information about Ant

Author:

Chris Clohosy

See Also:

AntInfoFactory

Method Summary

void	addTask(TaskDefinition task) Adds knowledge of a new task
void	addType(TypeDefinition type) Adds knowledge of a new type
boolean	doesTaskExist(String task) Whether a task exists
boolean	doesTypeExist(String type) Whether a type exists
String[]	getCategoryNames() Gets all the category names
TaskDefinition	getTask(String name) Gets a task by name
TaskDefinition[]	getTasks() Gets all the tasks known about
TaskDefinition[]	getTasks(String categoryName) Gets all the tasks belonging to a particular category
TypeDefinition	getType(String typeName) Gets a type if it knows about it
TypeDefinition[]	getTypes() Gets all the types known about

Method Detail

doesTaskExist

boolean doesTaskExist(String task)

Whether a task exists

Parameters:

task - the task to check for

Returns:

a boolean, whether it exists

doesTypeExist

boolean doesTypeExist(String type)

Whether a type exists

Parameters:

type - the type to check for

Returns:

a boolean, whether it exists

getCategoryNames

String[] getCategoryNames()

Gets all the category names

Returns:

a String[], the names

getTasks

TaskDefinition[] getTasks(String categoryName)

Gets all the tasks belonging to a particular category

Parameters:

categoryName - the category name to search with

Returns:

a TaskDefinition[], the tasks

getType

TypeDefinition getType(String typeName)

Gets a type if it knows about it

Parameters:

typeName - the name of the type required

Returns:

a TypeDefinition, the type that was required

getTypes

TypeDefinition[] getTypes()

Gets all the types known about

Returns:

a TypeDefinition[], the types

getTask

TaskDefinition getTask(String name)

Gets a task by name

Parameters:

name - the name of the task required

Returns:

a TaskDefinition, the task

getTasks

TaskDefinition[] getTasks()

Gets all the tasks known about

Returns:

a TaskDefinition[], the tasks

addTask

void addTask(TaskDefinition task)

Adds knowledge of a new task

Parameters:

task - the task to add

addType

void addType(TypeDefinition type)

Adds knowledge of a new type

Parameters:

type - the type to add