edu.uci.isr.xarch.options
Class OptionalImpl

java.lang.Object
  edu.uci.isr.xarch.options.OptionalImpl

All Implemented Interfaces:

DOMBased, IOptional, IXArchElement

public class OptionalImpl

extends Object

implements IOptional, DOMBased

DOM-Based implementation of the IOptional interface.

Author:

Automatically generated by xArch apigen.

Field Summary

protected Element	elt
static String	GUARD_ELT_NAME Tag name for guards in this object.
protected IXArch	xArch
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from interface edu.uci.isr.xarch.options.IOptional

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

OptionalImpl(Element elt)

Method Summary

void	clearGuard() Clear the guard from this Optional.
IXArchElement	cloneElement(int depth)
boolean	equals(Object o)
Node	getDOMNode() Gets the DOM node on which this implementation is based.
IGuard	getGuard() Get the guard from this Optional.
XArchInstanceMetadata	getInstanceMetadata() Gets metadata describing the instance of this element.
protected static SequenceOrder	getSequenceOrder()
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch()
boolean	hasGuard(IGuard value) Determine if this Optional has the given guard
int	hashCode()
boolean	isEquivalent(IOptional c) Determine if another Optional is equivalent to this one, ignoring ID's.
void	setDOMNode(Node node) Sets the DOM node on which this implementation is based.
void	setGuard(IGuard value) Set the guard for this Optional.
void	setXArch(IXArch xArch)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

XSD_TYPE_NSURI

public static final String XSD_TYPE_NSURI

See Also:

Constant Field Values

XSD_TYPE_NAME

public static final String XSD_TYPE_NAME

See Also:

Constant Field Values

xArch

protected IXArch xArch

GUARD_ELT_NAME

public static final String GUARD_ELT_NAME

Tag name for guards in this object.

See Also:

Constant Field Values

elt

protected Element elt

Constructor Detail

OptionalImpl

public OptionalImpl(Element elt)

Method Detail

getDOMNode

public Node getDOMNode()

Description copied from interface: DOMBased

Gets the DOM node on which this implementation is based.

Specified by:

getDOMNode in interface DOMBased

Returns:

DOM node

setDOMNode

public void setDOMNode(Node node)

Description copied from interface: DOMBased

Sets the DOM node on which this implementation is based.

Specified by:

setDOMNode in interface DOMBased

Parameters:

node - DOM node

getSequenceOrder

protected static SequenceOrder getSequenceOrder()

setXArch

public void setXArch(IXArch xArch)

Specified by:

setXArch in interface IXArchElement

getXArch

public IXArch getXArch()

Specified by:

getXArch in interface IXArchElement

cloneElement

public IXArchElement cloneElement(int depth)

Specified by:

cloneElement in interface IXArchElement

equals

public boolean equals(Object o)

hashCode

public int hashCode()

getTypeMetadata

public XArchTypeMetadata getTypeMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the xsi:type of this element.

Specified by:

getTypeMetadata in interface IXArchElement

Returns:

metadata describing the xsi:type of this element.

getInstanceMetadata

public XArchInstanceMetadata getInstanceMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the instance of this element.

Specified by:

getInstanceMetadata in interface IXArchElement

Returns:

metadata describing the instance of this element.

setGuard

public void setGuard(IGuard value)

Description copied from interface: IOptional

Set the guard for this Optional.

Specified by:

setGuard in interface IOptional

Parameters:

value - new guard

clearGuard

public void clearGuard()

Description copied from interface: IOptional

Clear the guard from this Optional.

Specified by:

clearGuard in interface IOptional

getGuard

public IGuard getGuard()

Description copied from interface: IOptional

Get the guard from this Optional.

Specified by:

getGuard in interface IOptional

Returns:

guard

hasGuard

public boolean hasGuard(IGuard value)

Description copied from interface: IOptional

Determine if this Optional has the given guard

Specified by:

hasGuard in interface IOptional

Parameters:

value - guard to compare

Returns:

true if the guards are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptional c)

Description copied from interface: IOptional

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

Specified by:

isEquivalent in interface IOptional

Parameters:

c - Optional to compare to this one.

Returns:

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