javax.xml.xquery

Interface XQSequenceType

public interface XQSequenceType

The XQSequenceType interface represents a sequence type as XQuery 1.0: An XML Query language. The XQSequenceType is the base interface for the XQItemType interface and contains an occurence indicator.
Field Summary
static intOCC_EMPTY
static intOCC_EXACTLY_ONE
static intOCC_ONE_OR_MORE
static intOCC_ZERO_OR_MORE
static intOCC_ZERO_OR_ONE
Method Summary
booleanequals(Object o)
Compares the specified object with this sequence type for equality.
intgetItemOccurrence()
Returns the occurrence indicator for the sequence type.
XQItemTypegetItemType()
Returns the type of the item in the sequence type.
inthashCode()
Returns a hash code consistent with the definition of the equals method.
StringtoString()
Returns a human-readable implementation-defined string representation of the sequence type.

Field Detail

OCC_EMPTY

public static final int OCC_EMPTY

OCC_EXACTLY_ONE

public static final int OCC_EXACTLY_ONE

OCC_ONE_OR_MORE

public static final int OCC_ONE_OR_MORE

OCC_ZERO_OR_MORE

public static final int OCC_ZERO_OR_MORE

OCC_ZERO_OR_ONE

public static final int OCC_ZERO_OR_ONE

Method Detail

equals

public boolean equals(Object o)
Compares the specified object with this sequence type for equality. The result is true only if the argument is a sequence type object which represents the same XQuery sequence type.

In order to comply with the general contract of equals and hashCode across different implementations the following algorithm must be used. Return true if and only if both objects are XQsequenceType and:

Parameters: o an XQItemType object representing an XQuery sequence type

Returns: true if the input item type object represents the same XQuery sequence type, false otherwise

getItemOccurrence

public int getItemOccurrence()
Returns the occurrence indicator for the sequence type. One of:

Description Value
Zero or one OCC_ZERO_OR_ONE
Exactly one OCC_EXACTLY_ONE
Zero or more OCC_ZERO_OR_MORE
One or more OCC_ONE_OR_MORE
Empty OCC_EMPTY

Returns: int indicating the occurrence indicator

getItemType

public XQItemType getItemType()
Returns the type of the item in the sequence type.

Returns: XQItemType representing the item type in the sequence. null is returned in case of an empty sequence.

hashCode

public int hashCode()
Returns a hash code consistent with the definition of the equals method.

In order to comply with the general contract of equals and hashCode across different implementations the following algorithm must be used:
  int hashCode;
  if (getItemOccurrence() == XQSequenceType.OCC_EMPTY)
  {
    hashCode = 1; 
  }
  else
  {
    hashCode = getItemOccurrence()*31 + getItemType().hashCode();
  }
 

Returns: hash code for this item type

toString

public String toString()
Returns a human-readable implementation-defined string representation of the sequence type.

Returns: a String representation of the sequence type