edu.uci.isr.xarch.boolguard
Interface IInRange

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

InRangeImpl

public interface IInRange

extends IXArchElement

Interface for accessing objects of the InRange xsi:type in the boolguard 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	addValue(IValue newValue) Add a value to this InRange.
void	addValues(Collection values) Add a collection of values to this InRange.
void	clearSymbol() Clear the symbol from this InRange.
void	clearValues() Remove all values from this InRange.
Collection	getAllValues() Get all the values from this InRange.
ISymbol	getSymbol() Get the symbol from this InRange.
boolean	hasAllValues(Collection valuesToCheck) Determine if this InRange contains each element in the given set of values.
boolean	hasSymbol(ISymbol symbolToCheck) Determine if this InRange has the given symbol
boolean	hasValue(IValue valueToCheck) Determine if this InRange contains a given value.
Collection	hasValues(Collection valuesToCheck) Determine if this InRange contains the given set of values.
boolean	isEquivalent(IInRange InRangeToCheck) Determine if another InRange is equivalent to this one, ignoring ID's.
void	removeValue(IValue valueToRemove) Remove the given value from this InRange.
void	removeValues(Collection values) Remove all the given values from this InRange.
void	setSymbol(ISymbol value) Set the symbol for this InRange.

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

setSymbol

public void setSymbol(ISymbol value)

Set the symbol for this InRange.

Parameters:

value - new symbol

clearSymbol

public void clearSymbol()

Clear the symbol from this InRange.

getSymbol

public ISymbol getSymbol()

Get the symbol from this InRange.

Returns:

symbol

hasSymbol

public boolean hasSymbol(ISymbol symbolToCheck)

Determine if this InRange has the given symbol

Parameters:

symbolToCheck - symbol to compare

Returns:

true if the symbols are equivalent, false otherwise

addValue

public void addValue(IValue newValue)

Add a value to this InRange.

Parameters:

newValue - value to add.

addValues

public void addValues(Collection values)

Add a collection of values to this InRange.

Parameters:

values - values to add.

clearValues

public void clearValues()

Remove all values from this InRange.

removeValue

public void removeValue(IValue valueToRemove)

Remove the given value from this InRange. Matching is done by the isEquivalent(...) function.

Parameters:

valueToRemove - value to remove.

removeValues

public void removeValues(Collection values)

Remove all the given values from this InRange. Matching is done by the isEquivalent(...) function.

Parameters:

values - value to remove.

getAllValues

public Collection getAllValues()

Get all the values from this InRange.

Returns:

all values in this InRange.

hasValue

public boolean hasValue(IValue valueToCheck)

Determine if this InRange contains a given value.

Returns:

true if this InRange contains the given valueToCheck, false otherwise.

hasValues

public Collection hasValues(Collection valuesToCheck)

Determine if this InRange contains the given set of values.

Parameters:

valuesToCheck - values to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in values was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllValues

public boolean hasAllValues(Collection valuesToCheck)

Determine if this InRange contains each element in the given set of values.

Parameters:

valuesToCheck - values to check for.

Returns:

true if every element in values is found in this InRange, false otherwise.

isEquivalent

public boolean isEquivalent(IInRange InRangeToCheck)

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

Parameters:

InRangeToCheck - InRange to compare to this one.

Returns:

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