edu.uci.isr.xarch.options
Interface IOptionalInterface

All Superinterfaces:

IInterface, IXArchElement

All Known Subinterfaces:

IOptionalInterfacePosition

All Known Implementing Classes:

OptionalInterfaceImpl, OptionalInterfacePositionImpl

public interface IOptionalInterface

extends IInterface, IXArchElement

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

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

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

Parameters:

value - new optional

clearOptional

public void clearOptional()

Clear the optional from this OptionalInterface.

getOptional

public IOptional getOptional()

Get the optional from this OptionalInterface.

Returns:

optional

hasOptional

public boolean hasOptional(IOptional optionalToCheck)

Determine if this OptionalInterface has the given optional

Parameters:

optionalToCheck - optional to compare

Returns:

true if the optionals are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptionalInterface OptionalInterfaceToCheck)

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

Parameters:

OptionalInterfaceToCheck - OptionalInterface to compare to this one.

Returns:

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