edu.uci.isr.xarch.boolguard
Interface IInSet

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

InSetImpl

public interface IInSet

extends IXArchElement

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

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

Parameters:

value - new symbol

clearSymbol

public void clearSymbol()

Clear the symbol from this InSet.

getSymbol

public ISymbol getSymbol()

Get the symbol from this InSet.

Returns:

symbol

hasSymbol

public boolean hasSymbol(ISymbol symbolToCheck)

Determine if this InSet 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 InSet.

Parameters:

newValue - value to add.

addValues

public void addValues(Collection values)

Add a collection of values to this InSet.

Parameters:

values - values to add.

clearValues

public void clearValues()

Remove all values from this InSet.

removeValue

public void removeValue(IValue valueToRemove)

Remove the given value from this InSet. 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 InSet. Matching is done by the isEquivalent(...) function.

Parameters:

values - value to remove.

getAllValues

public Collection getAllValues()

Get all the values from this InSet.

Returns:

all values in this InSet.

hasValue

public boolean hasValue(IValue valueToCheck)

Determine if this InSet contains a given value.

Returns:

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

hasValues

public Collection hasValues(Collection valuesToCheck)

Determine if this InSet 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 InSet 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 InSet, false otherwise.

isEquivalent

public boolean isEquivalent(IInSet InSetToCheck)

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

Parameters:

InSetToCheck - InSet to compare to this one.

Returns:

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