edu.uci.isr.xarch.options
Interface IOptionalSignature

All Superinterfaces:

ISignature, IXArchElement

All Known Subinterfaces:

IOptionalSignaturePosition

All Known Implementing Classes:

OptionalSignatureImpl, OptionalSignaturePositionImpl

public interface IOptionalSignature

extends ISignature, IXArchElement

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

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

clearDescription, clearDirection, clearId, clearType, getDescription, getDirection, getId, getType, hasDescription, hasDirection, hasId, hasType, isEqual, isEquivalent, setDescription, setDirection, setId, 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

setOptional

public void setOptional(IOptional value)

Set the optional for this OptionalSignature.

Parameters:

value - new optional

clearOptional

public void clearOptional()

Clear the optional from this OptionalSignature.

getOptional

public IOptional getOptional()

Get the optional from this OptionalSignature.

Returns:

optional

hasOptional

public boolean hasOptional(IOptional optionalToCheck)

Determine if this OptionalSignature has the given optional

Parameters:

optionalToCheck - optional to compare

Returns:

true if the optionals are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptionalSignature OptionalSignatureToCheck)

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

Parameters:

OptionalSignatureToCheck - OptionalSignature to compare to this one.

Returns:

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