org.exolab.jmscts.requirements
Class Requirements

java.lang.Object
  |
  +--org.exolab.jmscts.requirements.Requirements

public class Requirements

extends java.lang.Object

This class implements a cache of Requirement and Reference instances.

Version:

$Revision: 1.3 $ $Date: 2004/02/02 03:51:07 $

Author:

Tim Anderson

See Also:

Requirements

Constructor Summary

Requirements()

Method Summary

void	addReference(Reference reference) Add a reference
void	addRequirement(Requirement requirement) Add a requirement
Reference	getReference(java.lang.String referenceId) Get a reference by its identifier
Requirement	getRequirement(java.lang.String requirementId) Get a requirement by its identifier
java.util.HashMap	getRequirements() Returns the requirements as a map, with each requirement keyed on its requirement id

Methods inherited from class java.lang.Object

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

Constructor Detail

Requirements

public Requirements()

Method Detail

getRequirement

public Requirement getRequirement(java.lang.String requirementId)

Get a requirement by its identifier

Parameters:

requirementId - the requirement identifier

Returns:

the requirement, or null if it doesn't exist

getRequirements

public java.util.HashMap getRequirements()

Returns the requirements as a map, with each requirement keyed on its requirement id

Returns:

the requirements

getReference

public Reference getReference(java.lang.String referenceId)

Get a reference by its identifier

Parameters:

referenceId - the reference identifier

Returns:

the reference, or null if it doesn't exist

addRequirement

public void addRequirement(Requirement requirement)
                    throws org.exolab.castor.xml.ValidationException

Add a requirement

Parameters:

requirement - the requirement

Throws:

java.lang.IllegalArgumentException - if requirement is null

org.exolab.castor.xml.ValidationException - if the requirement is a duplicate of another, contains a duplicate reference, or contains an unknown reference id

addReference

public void addReference(Reference reference)
                  throws org.exolab.castor.xml.ValidationException

Add a reference

Parameters:

reference - the reference

Throws:

java.lang.IllegalArgumentException - if reference is null

org.exolab.castor.xml.ValidationException - if the reference is a duplicate of another