edu.uci.isr.xarch.messages
Interface INamedPropertyMessage

All Superinterfaces:

IGenericMessage, IXArchElement

All Known Implementing Classes:

NamedPropertyMessageImpl

public interface INamedPropertyMessage

extends IGenericMessage, IXArchElement

Interface for accessing objects of the NamedPropertyMessage xsi:type in the messages namespace. Extends and inherits the properties of the GenericMessage xsi:type.

Author:

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	addNamedProperty(INamedProperty newNamedProperty) Add a namedProperty to this NamedPropertyMessage.
void	addNamedPropertys(Collection namedPropertys) Add a collection of namedPropertys to this NamedPropertyMessage.
void	clearName() Clear the name from this NamedPropertyMessage.
void	clearNamedPropertys() Remove all namedPropertys from this NamedPropertyMessage.
Collection	getAllNamedPropertys() Get all the namedPropertys from this NamedPropertyMessage.
IMessageName	getName() Get the name from this NamedPropertyMessage.
boolean	hasAllNamedPropertys(Collection namedPropertysToCheck) Determine if this NamedPropertyMessage contains each element in the given set of namedPropertys.
boolean	hasName(IMessageName nameToCheck) Determine if this NamedPropertyMessage has the given name
boolean	hasNamedProperty(INamedProperty namedPropertyToCheck) Determine if this NamedPropertyMessage contains a given namedProperty.
Collection	hasNamedPropertys(Collection namedPropertysToCheck) Determine if this NamedPropertyMessage contains the given set of namedPropertys.
boolean	isEquivalent(INamedPropertyMessage NamedPropertyMessageToCheck) Determine if another NamedPropertyMessage is equivalent to this one, ignoring ID's.
void	removeNamedProperty(INamedProperty namedPropertyToRemove) Remove the given namedProperty from this NamedPropertyMessage.
void	removeNamedPropertys(Collection namedPropertys) Remove all the given namedPropertys from this NamedPropertyMessage.
void	setName(IMessageName value) Set the name for this NamedPropertyMessage.

Methods inherited from interface edu.uci.isr.xarch.messages.IGenericMessage

clearCount, clearDescription, clearId, clearKind, clearType, getCount, getDescription, getId, getKind, getType, hasCount, hasDescription, hasId, hasKind, hasType, isEqual, isEquivalent, setCount, setDescription, setId, setKind, setType

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(IMessageName value)

Set the name for this NamedPropertyMessage.

Parameters:

value - new name

clearName

public void clearName()

Clear the name from this NamedPropertyMessage.

getName

public IMessageName getName()

Get the name from this NamedPropertyMessage.

Returns:

name

hasName

public boolean hasName(IMessageName nameToCheck)

Determine if this NamedPropertyMessage has the given name

Parameters:

nameToCheck - name to compare

Returns:

true if the names are equivalent, false otherwise

addNamedProperty

public void addNamedProperty(INamedProperty newNamedProperty)

Add a namedProperty to this NamedPropertyMessage.

Parameters:

newNamedProperty - namedProperty to add.

addNamedPropertys

public void addNamedPropertys(Collection namedPropertys)

Add a collection of namedPropertys to this NamedPropertyMessage.

Parameters:

namedPropertys - namedPropertys to add.

clearNamedPropertys

public void clearNamedPropertys()

Remove all namedPropertys from this NamedPropertyMessage.

removeNamedProperty

public void removeNamedProperty(INamedProperty namedPropertyToRemove)

Remove the given namedProperty from this NamedPropertyMessage. Matching is done by the isEquivalent(...) function.

Parameters:

namedPropertyToRemove - namedProperty to remove.

removeNamedPropertys

public void removeNamedPropertys(Collection namedPropertys)

Remove all the given namedPropertys from this NamedPropertyMessage. Matching is done by the isEquivalent(...) function.

Parameters:

namedPropertys - namedProperty to remove.

getAllNamedPropertys

public Collection getAllNamedPropertys()

Get all the namedPropertys from this NamedPropertyMessage.

Returns:

all namedPropertys in this NamedPropertyMessage.

hasNamedProperty

public boolean hasNamedProperty(INamedProperty namedPropertyToCheck)

Determine if this NamedPropertyMessage contains a given namedProperty.

Returns:

true if this NamedPropertyMessage contains the given namedPropertyToCheck, false otherwise.

hasNamedPropertys

public Collection hasNamedPropertys(Collection namedPropertysToCheck)

Determine if this NamedPropertyMessage contains the given set of namedPropertys.

Parameters:

namedPropertysToCheck - namedPropertys to check for.

Returns:

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

hasAllNamedPropertys

public boolean hasAllNamedPropertys(Collection namedPropertysToCheck)

Determine if this NamedPropertyMessage contains each element in the given set of namedPropertys.

Parameters:

namedPropertysToCheck - namedPropertys to check for.

Returns:

true if every element in namedPropertys is found in this NamedPropertyMessage, false otherwise.

isEquivalent

public boolean isEquivalent(INamedPropertyMessage NamedPropertyMessageToCheck)

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

Parameters:

NamedPropertyMessageToCheck - NamedPropertyMessage to compare to this one.

Returns:

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