org.exolab.castor.tests.framework.testDescriptor

Class TestDescriptor

Implemented Interfaces:
java.io.Serializable

public class TestDescriptor
extends java.lang.Object
implements java.io.Serializable

Castor Testing Framework Test Descriptor XML Schema

Namespace: http://castor.exolab.org/Test

This schema is used to generate the org.exolab.castor.tests.framework.testdescriptor package Note: This schema is under evolution and subject to change. This schema is under the Exolab license.

Version:
$Revision: 6767 $ $Date$
See Also:
Serialized Form

Constructor Summary

TestDescriptor()

Method Summary

void
addComment(int index, java.lang.String vComment)
void
addComment(java.lang.String vComment)
void
deleteMinimumJavaVersion()
java.util.Enumeration
enumerateComment()
Method enumerateComment.
java.lang.String
getAuthor()
Returns the value of field 'author'.
BugFix
getBugFix()
Returns the value of field 'bugFix'.
CategoryType
getCategory()
Returns the value of field 'category'.
java.lang.String[]
getComment()
Method getComment.Returns the contents of the collection in an Array.
java.lang.String
getComment(int index)
Method getComment.
int
getCommentCount()
Method getCommentCount.
float
getMinimumJavaVersion()
Returns the value of field 'minimumJavaVersion'.
java.lang.String
getName()
Returns the value of field 'name'.
TestDescriptorChoice
getTestDescriptorChoice()
Returns the value of field 'testDescriptorChoice'.
boolean
hasMinimumJavaVersion()
Method hasMinimumJavaVersion.
boolean
isValid()
Method isValid.
void
marshal(java.io.Writer out)
void
marshal(org.xml.sax.ContentHandler handler)
void
removeAllComment()
boolean
removeComment(java.lang.String vComment)
Method removeComment.
java.lang.String
removeCommentAt(int index)
Method removeCommentAt.
void
setAuthor(java.lang.String author)
Sets the value of field 'author'.
void
setBugFix(BugFix bugFix)
Sets the value of field 'bugFix'.
void
setCategory(CategoryType category)
Sets the value of field 'category'.
void
setComment(int index, java.lang.String vComment)
void
setComment(java.lang.String[] vCommentArray)
void
setMinimumJavaVersion(float minimumJavaVersion)
Sets the value of field 'minimumJavaVersion'.
void
setName(java.lang.String name)
Sets the value of field 'name'.
void
setTestDescriptorChoice(TestDescriptorChoice testDescriptorChoice)
Sets the value of field 'testDescriptorChoice'.
static TestDescriptor
unmarshal(java.io.Reader reader)
Method unmarshal.
void
validate()

Constructor Details

TestDescriptor

public TestDescriptor()

Method Details

addComment

public void addComment(int index,
                       java.lang.String vComment)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vComment -

addComment

public void addComment(java.lang.String vComment)
            throws java.lang.IndexOutOfBoundsException
Parameters:
vComment -

deleteMinimumJavaVersion

public void deleteMinimumJavaVersion()

enumerateComment

public java.util.Enumeration enumerateComment()
Method enumerateComment.
Returns:
an Enumeration over all java.lang.String elements

getAuthor

public java.lang.String getAuthor()
Returns the value of field 'author'.
Returns:
the value of field 'Author'.

getBugFix

public BugFix getBugFix()
Returns the value of field 'bugFix'. The field 'bugFix' has the following description: Encapsulates information about a bug fix, including the reporter's name (or Email address), the date of the report and of the fix, and one or more comments about the bug.
Returns:
the value of field 'BugFix'.

getCategory

public CategoryType getCategory()
Returns the value of field 'category'.
Returns:
the value of field 'Category'.

getComment

public java.lang.String[] getComment()
Method getComment.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getComment

public java.lang.String getComment(int index)
            throws java.lang.IndexOutOfBoundsException
Method getComment.
Parameters:
index -
Returns:
the value of the java.lang.String at the given index

getCommentCount

public int getCommentCount()
Method getCommentCount.
Returns:
the size of this collection

getMinimumJavaVersion

public float getMinimumJavaVersion()
Returns the value of field 'minimumJavaVersion'.
Returns:
the value of field 'MinimumJavaVersion'.

getName

public java.lang.String getName()
Returns the value of field 'name'.
Returns:
the value of field 'Name'.

getTestDescriptorChoice

public TestDescriptorChoice getTestDescriptorChoice()
Returns the value of field 'testDescriptorChoice'.
Returns:
the value of field 'TestDescriptorChoice'.

hasMinimumJavaVersion

public boolean hasMinimumJavaVersion()
Method hasMinimumJavaVersion.
Returns:
true if at least one MinimumJavaVersion has been adde

isValid

public boolean isValid()
Method isValid.
Returns:
true if this object is valid according to the schema

marshal

public void marshal(java.io.Writer out)
            throws MarshalException,
                   ValidationException
Parameters:
out -
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
            throws java.io.IOException,
                   MarshalException,
                   ValidationException
Parameters:
handler -
Throws:
ValidationException - if this object is an invalid instance according to the schema
MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllComment

public void removeAllComment()

removeComment

public boolean removeComment(java.lang.String vComment)
Method removeComment.
Parameters:
vComment -
Returns:
true if the object was removed from the collection.

removeCommentAt

public java.lang.String removeCommentAt(int index)
Method removeCommentAt.
Parameters:
index -
Returns:
the element removed from the collection

setAuthor

public void setAuthor(java.lang.String author)
Sets the value of field 'author'.
Parameters:
author - the value of field 'author'.

setBugFix

public void setBugFix(BugFix bugFix)
Sets the value of field 'bugFix'. The field 'bugFix' has the following description: Encapsulates information about a bug fix, including the reporter's name (or Email address), the date of the report and of the fix, and one or more comments about the bug.
Parameters:
bugFix - the value of field 'bugFix'.

setCategory

public void setCategory(CategoryType category)
Sets the value of field 'category'.
Parameters:
category - the value of field 'category'.

setComment

public void setComment(int index,
                       java.lang.String vComment)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vComment -

setComment

public void setComment(java.lang.String[] vCommentArray)
Parameters:
vCommentArray -

setMinimumJavaVersion

public void setMinimumJavaVersion(float minimumJavaVersion)
Sets the value of field 'minimumJavaVersion'.
Parameters:
minimumJavaVersion - the value of field 'minimumJavaVersion'.

setName

public void setName(java.lang.String name)
Sets the value of field 'name'.
Parameters:
name - the value of field 'name'.

setTestDescriptorChoice

public void setTestDescriptorChoice(TestDescriptorChoice testDescriptorChoice)
Sets the value of field 'testDescriptorChoice'.
Parameters:
testDescriptorChoice - the value of field 'testDescriptorChoice'.

unmarshal

public static TestDescriptor unmarshal(java.io.Reader reader)
            throws MarshalException,
                   ValidationException
Method unmarshal.
Parameters:
reader -
Returns:
the unmarshaled org.exolab.castor.tests.framework.testDescriptor.TestDescriptor
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
            throws ValidationException
Throws:
ValidationException - if this object is an invalid instance according to the schema

Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com