org.exolab.jmscts.requirements
Class Requirement

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

All Implemented Interfaces:

java.io.Serializable

public class Requirement

extends java.lang.Object

implements java.io.Serializable

This element specifies a requirement, defined by the JMS specification or associated API documentation. A requirement may be optional.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Requirement()

Method Summary

void	addRequirementChoice(int index, RequirementChoice vRequirementChoice) Method addRequirementChoice
void	addRequirementChoice(RequirementChoice vRequirementChoice) Method addRequirementChoice
void	clearRequirementChoice() Method clearRequirementChoice
void	deleteOptional() Method deleteOptional
java.util.Enumeration	enumerateRequirementChoice() Method enumerateRequirementChoice
boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
Description	getDescription() Returns the value of field 'description'.
boolean	getOptional() Returns the value of field 'optional'.
RequirementChoice[]	getRequirementChoice() Method getRequirementChoice
RequirementChoice	getRequirementChoice(int index) Method getRequirementChoice
int	getRequirementChoiceCount() Method getRequirementChoiceCount
java.lang.String	getRequirementId() Returns the value of field 'requirementId'.
boolean	hasOptional() Method hasOptional
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
boolean	removeRequirementChoice(RequirementChoice vRequirementChoice) Method removeRequirementChoice
void	setDescription(Description description) Sets the value of field 'description'.
void	setOptional(boolean optional) Sets the value of field 'optional'.
void	setRequirementChoice(int index, RequirementChoice vRequirementChoice) Method setRequirementChoice
void	setRequirementChoice(RequirementChoice[] requirementChoiceArray) Method setRequirementChoice
void	setRequirementId(java.lang.String requirementId) Sets the value of field 'requirementId'.
static Requirement	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Requirement

public Requirement()

Method Detail

addRequirementChoice

public void addRequirementChoice(RequirementChoice vRequirementChoice)
                          throws java.lang.IndexOutOfBoundsException

Method addRequirementChoice

Parameters:

vRequirementChoice -

addRequirementChoice

public void addRequirementChoice(int index,
                                 RequirementChoice vRequirementChoice)
                          throws java.lang.IndexOutOfBoundsException

Method addRequirementChoice

Parameters:

index -

vRequirementChoice -

clearRequirementChoice

public void clearRequirementChoice()

Method clearRequirementChoice

deleteOptional

public void deleteOptional()

Method deleteOptional

enumerateRequirementChoice

public java.util.Enumeration enumerateRequirementChoice()

Method enumerateRequirementChoice

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class java.lang.Object

Parameters:

obj -

getDescription

public Description getDescription()

Returns the value of field 'description'.

Returns:

the value of field 'description'.

getOptional

public boolean getOptional()

Returns the value of field 'optional'.

Returns:

the value of field 'optional'.

getRequirementChoice

public RequirementChoice getRequirementChoice(int index)
                                       throws java.lang.IndexOutOfBoundsException

Method getRequirementChoice

Parameters:

index -

getRequirementChoice

public RequirementChoice[] getRequirementChoice()

Method getRequirementChoice

getRequirementChoiceCount

public int getRequirementChoiceCount()

Method getRequirementChoiceCount

getRequirementId

public java.lang.String getRequirementId()

Returns the value of field 'requirementId'.

Returns:

the value of field 'requirementId'.

hasOptional

public boolean hasOptional()

Method hasOptional

isValid

public boolean isValid()

Method isValid

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

removeRequirementChoice

public boolean removeRequirementChoice(RequirementChoice vRequirementChoice)

Method removeRequirementChoice

Parameters:

vRequirementChoice -

setDescription

public void setDescription(Description description)

Sets the value of field 'description'.

Parameters:

description - the value of field 'description'.

setOptional

public void setOptional(boolean optional)

Sets the value of field 'optional'.

Parameters:

optional - the value of field 'optional'.

setRequirementChoice

public void setRequirementChoice(int index,
                                 RequirementChoice vRequirementChoice)
                          throws java.lang.IndexOutOfBoundsException

Method setRequirementChoice

Parameters:

index -

vRequirementChoice -

setRequirementChoice

public void setRequirementChoice(RequirementChoice[] requirementChoiceArray)

Method setRequirementChoice

Parameters:

requirementChoiceArray -

setRequirementId

public void setRequirementId(java.lang.String requirementId)

Sets the value of field 'requirementId'.

Parameters:

requirementId - the value of field 'requirementId'.

unmarshal

public static Requirement unmarshal(java.io.Reader reader)
                             throws org.exolab.castor.xml.MarshalException,
                                    org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate