edu.uci.isr.xarch.options
Interface IOptional

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

OptionalImpl

public interface IOptional

extends IXArchElement

Interface for accessing objects of the Optional xsi:type in the options 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	clearGuard() Clear the guard from this Optional.
IGuard	getGuard() Get the guard from this Optional.
boolean	hasGuard(IGuard guardToCheck) Determine if this Optional has the given guard
boolean	isEquivalent(IOptional OptionalToCheck) Determine if another Optional is equivalent to this one, ignoring ID's.
void	setGuard(IGuard value) Set the guard for this Optional.

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

setGuard

public void setGuard(IGuard value)

Set the guard for this Optional.

Parameters:

value - new guard

clearGuard

public void clearGuard()

Clear the guard from this Optional.

getGuard

public IGuard getGuard()

Get the guard from this Optional.

Returns:

guard

hasGuard

public boolean hasGuard(IGuard guardToCheck)

Determine if this Optional has the given guard

Parameters:

guardToCheck - guard to compare

Returns:

true if the guards are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptional OptionalToCheck)

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

Parameters:

OptionalToCheck - Optional to compare to this one.

Returns:

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