com.tailf.util

Class XMLtoConfXMLParam

Object

com.tailf.util.XMLtoConfXMLParam

public class XMLtoConfXMLParam
extends Object

Convenience utility class for transformation from a XML String to a ConfXMLParam[] structure.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_GET parse xml as preparation for a getValues() call
static int	MODE_SET parse xml as preparation for a setValues() call

Constructor Summary

Constructors

Constructor and Description
XMLtoConfXMLParam(String xml, ConfPath path) Main constructor for initializing the xml parser.

Method Summary

Modifier and Type	Method and Description
ConfXMLParam[]	toXMLParam() Converts the xml to corresponding ConfXMLParam[] The resulting ConfXMLParam[] is prepared for a getValues() call.
ConfXMLParam[]	toXMLParam(int mode) Converts the xml to corresponding ConfXMLParam[] The mode parameter controls whether this ConfXMLParam[] should be prepared for a getValues() call or for a setValues() call using using XMLtoConfXMLParam.MODE_GET or XMLtoConfXMLParam.MODE_SET respectively.

Methods inherited from class Object

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

Field Detail

MODE_GET

public static final int MODE_GET

parse xml as preparation for a getValues() call

See Also:

Constant Field Values

MODE_SET

public static final int MODE_SET

parse xml as preparation for a setValues() call

See Also:

Constant Field Values

Constructor Detail

XMLtoConfXMLParam

public XMLtoConfXMLParam(String xml,
                         ConfPath path)
                  throws ConfException

Main constructor for initializing the xml parser.

Parameters:

xml - well formed XML string that represent a instance document rooted by the path

path - Start node (or root path) of the XML document

Throws:

ConfException

Method Detail

toXMLParam

public ConfXMLParam[] toXMLParam()
                          throws ConfException

Converts the xml to corresponding ConfXMLParam[] The resulting ConfXMLParam[] is prepared for a getValues() call.

Returns:

The resulting ConfXMLParam[]

Throws:

ConfException

toXMLParam

public ConfXMLParam[] toXMLParam(int mode)
                          throws ConfException

Converts the xml to corresponding ConfXMLParam[] The mode parameter controls whether this ConfXMLParam[] should be prepared for a getValues() call or for a setValues() call using using XMLtoConfXMLParam.MODE_GET or XMLtoConfXMLParam.MODE_SET respectively.

Parameters:

mode - one of XMLtoConfXMLParam.MODE_GET or XMLtoConfXMLParam.MODE_SET

Returns:

the resulting ConfXMLParam[]

Throws:

ConfException