edu.uci.isr.xarch.menage
Interface IOptionalSignaturePosition

All Superinterfaces:

IOptionalSignature, ISignature, IXArchElement

All Known Implementing Classes:

OptionalSignaturePositionImpl

public interface IOptionalSignaturePosition

extends IOptionalSignature, IXArchElement

Interface for accessing objects of the OptionalSignaturePosition xsi:type in the menage namespace. Extends and inherits the properties of the OptionalSignature 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	clearPosition() Clear the position from this OptionalSignaturePosition.
IPosition	getPosition() Get the position from this OptionalSignaturePosition.
boolean	hasPosition(IPosition positionToCheck) Determine if this OptionalSignaturePosition has the given position
boolean	isEquivalent(IOptionalSignaturePosition OptionalSignaturePositionToCheck) Determine if another OptionalSignaturePosition is equivalent to this one, ignoring ID's.
void	setPosition(IPosition value) Set the position for this OptionalSignaturePosition.

Methods inherited from interface edu.uci.isr.xarch.options.IOptionalSignature

clearOptional, getOptional, hasOptional, isEquivalent, setOptional

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

setPosition

public void setPosition(IPosition value)

Set the position for this OptionalSignaturePosition.

Parameters:

value - new position

clearPosition

public void clearPosition()

Clear the position from this OptionalSignaturePosition.

getPosition

public IPosition getPosition()

Get the position from this OptionalSignaturePosition.

Returns:

position

hasPosition

public boolean hasPosition(IPosition positionToCheck)

Determine if this OptionalSignaturePosition has the given position

Parameters:

positionToCheck - position to compare

Returns:

true if the positions are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptionalSignaturePosition OptionalSignaturePositionToCheck)

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

Parameters:

OptionalSignaturePositionToCheck - OptionalSignaturePosition to compare to this one.

Returns:

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