org.protempa

Class Algorithms

java.lang.Object

org.protempa.Algorithms

All Implemented Interfaces:

Serializable

public final class Algorithms
extends Object
implements Serializable

The set of defined algorithms. A maximum of Integer.MAX_VALUE algorithms may be defined.

Author:

Andrew Post

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	addAlgorithm(Algorithm algorithm) Adds a new algorithm.
Algorithm	getAlgorithm(String id) Returns the algorithm with a given id.
Set<Algorithm>	getAlgorithms() Returns all algorithms.
boolean	hasAlgorithm(String id) Returns whether an algorithm exists with the given id.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getAlgorithms

public Set<Algorithm> getAlgorithms()

Returns all algorithms.

Returns:

a newly-created Set of Algorithm objects.

hasAlgorithm

public boolean hasAlgorithm(String id)

Returns whether an algorithm exists with the given id.

Parameters:

id - an algorithm id String.

Returns:

true if the algorithm exists, false otherwise.

getAlgorithm

public Algorithm getAlgorithm(String id)

Returns the algorithm with a given id.

Parameters:

id - an algorithm id String.

Returns:

an Algorithm object, or null if no algorithm with the given id exists or the given id is null.

addAlgorithm

public boolean addAlgorithm(Algorithm algorithm)

Adds a new algorithm.

Parameters:

algorithm - an Algorithm object.

Returns:

true if successful, false if not.

toString

public String toString()

Overrides:

toString in class Object