org.fopps.model
Class ArtefactCategory

java.lang.Object
  |
  +--org.fopps.model.ArtefactCategory

All Implemented Interfaces:

Enum

public class ArtefactCategory

extends java.lang.Object

implements Enum

Holds all possible catagories

Field Summary

static ArtefactCategory	Documentation
static java.lang.String	DOCUMENTATION
static java.lang.String	SOURCE_CODE
static ArtefactCategory	SourceCode
static java.lang.String	TEST_REPORT
static ArtefactCategory	TestReport
static ArtefactCategory	Unspecified
static java.lang.String	UNSPECIFIED

Method Summary

static ArtefactCategory	addCategory(java.lang.String pName) Adds a category and returns the corresponding instance.
static ArtefactCategory	byName(java.lang.String pName) Returns an instance of an artefact by name
static java.util.Set	getCategories() Returns all existing categories
static ArtefactCategory	getCategory(java.lang.String pName) Returns the category instance for a given name
java.lang.Object	getDefault() Returns the default value of the enumeration
java.lang.Object[]	getInstances() Returns all possible instances of the enumeration
java.lang.String	getName() Returns the name of the category
int	getValue() Returns the current value (numeric representation) of the enumeration.
static void	removeCategory(java.lang.String pName) Removes an existing category
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED

public static final java.lang.String UNSPECIFIED

See Also:

Constant Field Values

Unspecified

public static final ArtefactCategory Unspecified

SOURCE_CODE

public static final java.lang.String SOURCE_CODE

See Also:

Constant Field Values

SourceCode

public static final ArtefactCategory SourceCode

DOCUMENTATION

public static final java.lang.String DOCUMENTATION

See Also:

Constant Field Values

Documentation

public static final ArtefactCategory Documentation

TEST_REPORT

public static final java.lang.String TEST_REPORT

See Also:

Constant Field Values

TestReport

public static final ArtefactCategory TestReport

Method Detail

addCategory

public static ArtefactCategory addCategory(java.lang.String pName)

Adds a category and returns the corresponding instance.

Parameters:

pName - name of the category to add

removeCategory

public static void removeCategory(java.lang.String pName)
                           throws ModelException

Removes an existing category

Parameters:

pName - name of the category to delete

ModelException

getCategories

public static java.util.Set getCategories()

Returns all existing categories

Returns:

Collection of category names

getCategory

public static ArtefactCategory getCategory(java.lang.String pName)

Returns the category instance for a given name

Returns:

Category instance or null if category not exists

getValue

public int getValue()

Description copied from interface: Enum

Returns the current value (numeric representation) of the enumeration.

Specified by:

getValue in interface Enum

See Also:

Enum.getValue()

getName

public java.lang.String getName()

Returns the name of the category

byName

public static ArtefactCategory byName(java.lang.String pName)

Returns an instance of an artefact by name

getDefault

public java.lang.Object getDefault()

Returns the default value of the enumeration

Specified by:

getDefault in interface Enum

getInstances

public java.lang.Object[] getInstances()

Description copied from interface: Enum

Returns all possible instances of the enumeration

Specified by:

getInstances in interface Enum

See Also:

Enum.getInstances()

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.