edu.uci.isr.xarch.hints
Interface IPropertyHint

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

PropertyHintImpl

public interface IPropertyHint

extends IXArchElement

Interface for accessing objects of the PropertyHint xsi:type in the hints 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 PropertyHint.
void	clearValue() Remove the value attribute from this PropertyHint.
String	getName() Get the name attribute from this PropertyHint.
String	getValue() Get the value attribute from this PropertyHint.
boolean	hasName(String name) Determine if the name attribute on this PropertyHint has the given value.
boolean	hasValue(String value) Determine if the value attribute on this PropertyHint has the given value.
boolean	isEquivalent(IPropertyHint PropertyHintToCheck) Determine if another PropertyHint is equivalent to this one, ignoring ID's.
void	setName(String name) Set the name attribute on this PropertyHint.
void	setValue(String value) Set the value attribute on this PropertyHint.

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 PropertyHint.

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 PropertyHint.

getName

public String getName()

Get the name attribute from this PropertyHint. 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 PropertyHint

hasName

public boolean hasName(String name)

Determine if the name attribute on this PropertyHint 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 PropertyHint.

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 PropertyHint.

getValue

public String getValue()

Get the value attribute from this PropertyHint. 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 PropertyHint

hasValue

public boolean hasValue(String value)

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

Parameters:

value - Attribute value to compare

Returns:

true if they match; false otherwise.

isEquivalent

public boolean isEquivalent(IPropertyHint PropertyHintToCheck)

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

Parameters:

PropertyHintToCheck - PropertyHint to compare to this one.

Returns:

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