edu.uci.isr.xarch.options
Interface IOptionalSignatureInterfaceMapping

All Superinterfaces:

ISignatureInterfaceMapping, IXArchElement

All Known Implementing Classes:

OptionalSignatureInterfaceMappingImpl

public interface IOptionalSignatureInterfaceMapping

extends ISignatureInterfaceMapping, IXArchElement

Interface for accessing objects of the OptionalSignatureInterfaceMapping xsi:type in the options namespace. Extends and inherits the properties of the SignatureInterfaceMapping 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	clearOptional() Clear the optional from this OptionalSignatureInterfaceMapping.
IOptional	getOptional() Get the optional from this OptionalSignatureInterfaceMapping.
boolean	hasOptional(IOptional optionalToCheck) Determine if this OptionalSignatureInterfaceMapping has the given optional
boolean	isEquivalent(IOptionalSignatureInterfaceMapping OptionalSignatureInterfaceMappingToCheck) Determine if another OptionalSignatureInterfaceMapping is equivalent to this one, ignoring ID's.
void	setOptional(IOptional value) Set the optional for this OptionalSignatureInterfaceMapping.

Methods inherited from interface edu.uci.isr.xarch.types.ISignatureInterfaceMapping

clearDescription, clearId, clearInnerInterface, clearOuterSignature, getDescription, getId, getInnerInterface, getOuterSignature, hasDescription, hasId, hasInnerInterface, hasOuterSignature, isEqual, isEquivalent, setDescription, setId, setInnerInterface, setOuterSignature

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

setOptional

public void setOptional(IOptional value)

Set the optional for this OptionalSignatureInterfaceMapping.

Parameters:

value - new optional

clearOptional

public void clearOptional()

Clear the optional from this OptionalSignatureInterfaceMapping.

getOptional

public IOptional getOptional()

Get the optional from this OptionalSignatureInterfaceMapping.

Returns:

optional

hasOptional

public boolean hasOptional(IOptional optionalToCheck)

Determine if this OptionalSignatureInterfaceMapping has the given optional

Parameters:

optionalToCheck - optional to compare

Returns:

true if the optionals are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptionalSignatureInterfaceMapping OptionalSignatureInterfaceMappingToCheck)

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

Parameters:

OptionalSignatureInterfaceMappingToCheck - OptionalSignatureInterfaceMapping to compare to this one.

Returns:

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