edu.uci.isr.xarch.javainitparams
Interface IInitializationParameter

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

InitializationParameterImpl

public interface IInitializationParameter

extends IXArchElement

Interface for accessing objects of the InitializationParameter xsi:type in the javainitparams namespace.

Author:

Automatically generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	clearName() Remove the name attribute from this InitializationParameter.
void	clearValue() Remove the value attribute from this InitializationParameter.
String	getName() Get the name attribute from this InitializationParameter.
String	getValue() Get the value attribute from this InitializationParameter.
boolean	hasName(String name) Determine if the name attribute on this InitializationParameter has the given value.
boolean	hasValue(String value) Determine if the value attribute on this InitializationParameter has the given value.
boolean	isEquivalent(IInitializationParameter InitializationParameterToCheck) Determine if another InitializationParameter is equivalent to this one, ignoring ID's.
void	setName(String name) Set the name attribute on this InitializationParameter.
void	setValue(String value) Set the value attribute on this InitializationParameter.

Methods inherited from interface edu.uci.isr.xarch.IXArchElement

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

setName

public void setName(String name)

Set the name attribute on this InitializationParameter.

Parameters:

name - name

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearName

public void clearName()

Remove the name attribute from this InitializationParameter.

getName

public String getName()

Get the name attribute from this InitializationParameter. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

name on this InitializationParameter

hasName

public boolean hasName(String name)

Determine if the name attribute on this InitializationParameter has the given value.

Parameters:

name - Attribute value to compare

Returns:

true if they match; false otherwise.

setValue

public void setValue(String value)

Set the value attribute on this InitializationParameter.

Parameters:

value - value

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearValue

public void clearValue()

Remove the value attribute from this InitializationParameter.

getValue

public String getValue()

Get the value attribute from this InitializationParameter. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

value on this InitializationParameter

hasValue

public boolean hasValue(String value)

Determine if the value attribute on this InitializationParameter has the given value.

Parameters:

value - Attribute value to compare

Returns:

true if they match; false otherwise.

isEquivalent

public boolean isEquivalent(IInitializationParameter InitializationParameterToCheck)

Determine if another InitializationParameter is equivalent to this one, ignoring ID's.

Parameters:

InitializationParameterToCheck - InitializationParameter to compare to this one.

Returns:

true if all the child elements of this InitializationParameter are equivalent, false otherwise.