edu.uci.isr.xarch.messages
Interface IMessageCausalitySpecification

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

MessageCausalitySpecificationImpl

public interface IMessageCausalitySpecification

extends IXArchElement

Interface for accessing objects of the MessageCausalitySpecification xsi:type in the messages 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	addRule(IXMLLink newRule) Add a rule to this MessageCausalitySpecification.
void	addRules(Collection rules) Add a collection of rules to this MessageCausalitySpecification.
void	clearRules() Remove all rules from this MessageCausalitySpecification.
Collection	getAllRules() Get all the rules from this MessageCausalitySpecification.
boolean	hasAllRules(Collection rulesToCheck) Determine if this MessageCausalitySpecification contains each element in the given set of rules.
boolean	hasRule(IXMLLink ruleToCheck) Determine if this MessageCausalitySpecification contains a given rule.
Collection	hasRules(Collection rulesToCheck) Determine if this MessageCausalitySpecification contains the given set of rules.
boolean	isEquivalent(IMessageCausalitySpecification MessageCausalitySpecificationToCheck) Determine if another MessageCausalitySpecification is equivalent to this one, ignoring ID's.
void	removeRule(IXMLLink ruleToRemove) Remove the given rule from this MessageCausalitySpecification.
void	removeRules(Collection rules) Remove all the given rules from this MessageCausalitySpecification.

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

addRule

public void addRule(IXMLLink newRule)

Add a rule to this MessageCausalitySpecification.

Parameters:

newRule - rule to add.

addRules

public void addRules(Collection rules)

Add a collection of rules to this MessageCausalitySpecification.

Parameters:

rules - rules to add.

clearRules

public void clearRules()

Remove all rules from this MessageCausalitySpecification.

removeRule

public void removeRule(IXMLLink ruleToRemove)

Remove the given rule from this MessageCausalitySpecification. Matching is done by the isEquivalent(...) function.

Parameters:

ruleToRemove - rule to remove.

removeRules

public void removeRules(Collection rules)

Remove all the given rules from this MessageCausalitySpecification. Matching is done by the isEquivalent(...) function.

Parameters:

rules - rule to remove.

getAllRules

public Collection getAllRules()

Get all the rules from this MessageCausalitySpecification.

Returns:

all rules in this MessageCausalitySpecification.

hasRule

public boolean hasRule(IXMLLink ruleToCheck)

Determine if this MessageCausalitySpecification contains a given rule.

Returns:

true if this MessageCausalitySpecification contains the given ruleToCheck, false otherwise.

hasRules

public Collection hasRules(Collection rulesToCheck)

Determine if this MessageCausalitySpecification contains the given set of rules.

Parameters:

rulesToCheck - rules to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in rules 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.

hasAllRules

public boolean hasAllRules(Collection rulesToCheck)

Determine if this MessageCausalitySpecification contains each element in the given set of rules.

Parameters:

rulesToCheck - rules to check for.

Returns:

true if every element in rules is found in this MessageCausalitySpecification, false otherwise.

isEquivalent

public boolean isEquivalent(IMessageCausalitySpecification MessageCausalitySpecificationToCheck)

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

Parameters:

MessageCausalitySpecificationToCheck - MessageCausalitySpecification to compare to this one.

Returns:

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