junit.extensions.xml
Interface IXMLTest

All Superinterfaces:
junit.framework.Test
All Known Subinterfaces:
IXMLTestCase, IXMLTestSuite
All Known Implementing Classes:
JFCXMLTestCase, XMLTestCase, XMLTestSuite

public interface IXMLTest
extends junit.framework.Test

Test Case for running XML Script based testing.

Author:
Kevin Wilson

Method Summary
 void addProcedure(IXMLProcedure proc)
          Adds a XML Procedure to the test sutie.
 void addProperty(java.lang.String name, java.lang.Object obj)
          Add each found object into the cache map.
 void clearProperties()
          For each test (method) element, the found objects has to be cleared.
 boolean getDebug()
          get the debug state.
 IXMLProcedure getProcedure(java.lang.String name)
          Get the XML procedure by the name given.
 XMLObjectCache getProcedureCache()
          Retrun the cache of procedures.
 java.lang.Object getProperty(java.lang.String name)
          Retrieve the object that was found previously.
 XMLObjectCache getPropertyCache()
          Get the Found object cache.
 java.lang.String getPropertyName(java.lang.Object comp)
          Retrieve the name of a object which was previously found.
 java.lang.String[] getPropertyNames()
          Get the names of the found objects.
 void removeProperty(java.lang.String name)
          Remove the property by name.
 java.lang.String resolveProperties(java.lang.String value)
          Resolve embeded property values.
 void setParent(IXMLTest parent)
          set the Parent test case.
 
Methods inherited from interface junit.framework.Test
countTestCases, run
 

Method Detail

getDebug

public boolean getDebug()
get the debug state.

Returns:
true if debugging is enabled.

setParent

public void setParent(IXMLTest parent)
set the Parent test case.

Parameters:
parent - Parent test case.

getProcedure

public IXMLProcedure getProcedure(java.lang.String name)
Get the XML procedure by the name given.

Parameters:
name - Name of the procedure.
Returns:
Procedure.

getProcedureCache

public XMLObjectCache getProcedureCache()
Retrun the cache of procedures.

Returns:
XMLObjectCache used to hold the procedures.

getProperty

public java.lang.Object getProperty(java.lang.String name)
Retrieve the object that was found previously.

Parameters:
name - The name of the object that was found.
Returns:
The object to be retrieved.

getPropertyCache

public XMLObjectCache getPropertyCache()
Get the Found object cache.

Returns:
XMLObjectCahce

getPropertyName

public java.lang.String getPropertyName(java.lang.Object comp)
Retrieve the name of a object which was previously found.

Parameters:
comp - Component which is to be found.
Returns:
Name of the component.

getPropertyNames

public java.lang.String[] getPropertyNames()
Get the names of the found objects.

Returns:
array containing the names of the objects.

addProcedure

public void addProcedure(IXMLProcedure proc)
Adds a XML Procedure to the test sutie.

Parameters:
proc - Procedure to be added.

addProperty

public void addProperty(java.lang.String name,
                        java.lang.Object obj)
Add each found object into the cache map.

Parameters:
name - The name of the found object.
obj - The actual object that was found.

clearProperties

public void clearProperties()
For each test (method) element, the found objects has to be cleared.


removeProperty

public void removeProperty(java.lang.String name)
Remove the property by name.

Parameters:
name - Name of the property to be removed.

resolveProperties

public java.lang.String resolveProperties(java.lang.String value)
Resolve embeded property values.

Parameters:
value - Value which may contain properties to be resolved.
Returns:
String without property names.


Licensed under: GNU Lesser General Public License, Ver 2.1, February 1999