SerializableTuple

java.lang.Object
- com.ibm.commerce.datatype.SerializableTuple

All Implemented Interfaces:

java.io.Serializable
```
public final class SerializableTuple
extends java.lang.Object
implements java.io.Serializable
```
This class wraps an array of serializable objects. SerializableTuple objects can be used as keys in hash tables.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field

Constructor Summary

Constructors
Constructor and Description
`SerializableTuple()` This is the default constructor for this class.
`SerializableTuple(java.io.Serializable aSerializable1)` This is a single object constructor for this class.
`SerializableTuple(java.io.Serializable[] aSerializableArray)` This is a generic constructor for this class.
`SerializableTuple(java.io.Serializable aSerializable1, java.io.Serializable aSerializable2)` This is a constructor for two objects.
`SerializableTuple(java.io.Serializable aSerializable1, java.io.Serializable aSerializable2, java.io.Serializable aSerializable3)` This is a constructor for three objects.
`SerializableTuple(java.io.Serializable aSerializable1, java.io.Serializable aSerializable2, java.io.Serializable aSerializable3, java.io.Serializable aSerializable4)` This is a constructor for four objects.
`SerializableTuple(java.io.Serializable aSerializable1, java.io.Serializable aSerializable2, java.io.Serializable aSerializable3, java.io.Serializable aSerializable4, java.io.Serializable aSerializable5)` This is a constructor for five objects.
`SerializableTuple(java.io.Serializable aSerializable1, java.io.Serializable aSerializable2, java.io.Serializable aSerializable3, java.io.Serializable aSerializable4, java.io.Serializable aSerializable5, java.io.Serializable aSerializable6)` This is a constructor for six objects.
`SerializableTuple(java.io.Serializable aSerializable1, java.io.Serializable aSerializable2, java.io.Serializable aSerializable3, java.io.Serializable aSerializable4, java.io.Serializable aSerializable5, java.io.Serializable aSerializable6, java.io.Serializable aSerializable7)` This is a constructor for seven objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object aObject)` This method checks for equality.
`java.io.Serializable`	`getElement(int i)` This method returns the specified array element.
`int`	`getLength()` This method returns the length of the array.
`int`	`hashCode()` This method returns the hash code.
`SerializableTuple`	`setArray(java.io.Serializable[] aSerializableArray)` This method replaces the array with a clone of the specified array.
`SerializableTuple`	`setElement(int i, java.io.Serializable aSerializable)` This method replaces the specified array element with the specified `Object`.
`java.io.Serializable[]`	`toArray()` This method returns a clone of the array.
`java.lang.String`	`toString()` Returns a `String` representation of this object, suitable for printing in trace statements.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SerializableTuple
```
public SerializableTuple()
```
    This is the default constructor for this class. It wraps an empty array.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable[] aSerializableArray)
```
    This is a generic constructor for this class. It wraps a clone of a specified array.
    
    Parameters:
    
    aSerializableArray - The array to be cloned.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable aSerializable1)
```
    This is a single object constructor for this class. It wraps an array whose single element is the specified parameter.
    
    Parameters:
    
    aSerializable1 - the specified parameter.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable aSerializable1,
                         java.io.Serializable aSerializable2)
```
    This is a constructor for two objects. It wraps an array whose two elements are the specified parameters.
    
    Parameters:
    
    aSerializable1 - parameter 1.
    
    aSerializable2 - parameter 2.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable aSerializable1,
                         java.io.Serializable aSerializable2,
                         java.io.Serializable aSerializable3)
```
    This is a constructor for three objects. It wraps an array whose three elements are the specified parameters.
    
    Parameters:
    
    aSerializable1 - parameter 1.
    
    aSerializable2 - parameter 2.
    
    aSerializable3 - parameter 3.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable aSerializable1,
                         java.io.Serializable aSerializable2,
                         java.io.Serializable aSerializable3,
                         java.io.Serializable aSerializable4)
```
    This is a constructor for four objects. It wraps an array whose four elements are the specified parameters.
    
    Parameters:
    
    aSerializable1 - parameter 1.
    
    aSerializable2 - parameter 2.
    
    aSerializable3 - parameter 3.
    
    aSerializable4 - parameter 4.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable aSerializable1,
                         java.io.Serializable aSerializable2,
                         java.io.Serializable aSerializable3,
                         java.io.Serializable aSerializable4,
                         java.io.Serializable aSerializable5)
```
    This is a constructor for five objects. It wraps an array whose five elements are the specified parameters.
    
    Parameters:
    
    aSerializable1 - parameter 1.
    
    aSerializable2 - parameter 2.
    
    aSerializable3 - parameter 3.
    
    aSerializable4 - parameter 4.
    
    aSerializable5 - parameter 5.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable aSerializable1,
                         java.io.Serializable aSerializable2,
                         java.io.Serializable aSerializable3,
                         java.io.Serializable aSerializable4,
                         java.io.Serializable aSerializable5,
                         java.io.Serializable aSerializable6)
```
    This is a constructor for six objects. It wraps an array whose six elements are the specified parameters.
    
    Parameters:
    
    aSerializable1 - parameter 1.
    
    aSerializable2 - parameter 2.
    
    aSerializable3 - parameter 3.
    
    aSerializable4 - parameter 4.
    
    aSerializable5 - parameter 5.
    
    aSerializable6 - parameter 6.
  - SerializableTuple
```
public SerializableTuple(java.io.Serializable aSerializable1,
                         java.io.Serializable aSerializable2,
                         java.io.Serializable aSerializable3,
                         java.io.Serializable aSerializable4,
                         java.io.Serializable aSerializable5,
                         java.io.Serializable aSerializable6,
                         java.io.Serializable aSerializable7)
```
    This is a constructor for seven objects. It wraps an array whose seven elements are the specified parameters.
    
    Parameters:
    
    aSerializable1 - parameter 1.
    
    aSerializable2 - parameter 2.
    
    aSerializable3 - parameter 3.
    
    aSerializable4 - parameter 4.
    
    aSerializable5 - parameter 5.
    
    aSerializable6 - parameter 6.
    
    aSerializable7 - parameter 7.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object aObject)
```
    This method checks for equality. Two SerializableTuple objects are considered equal if their arrays are considered equal by the Arrays.equals(Object[],Object[]) method.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    True if the specified object is equal to this object, false otherwise.
    
    See Also:
    
    Object#equals().
  - getLength
```
public int getLength()
```
    This method returns the length of the array.
    
    Returns:
    
    The length of the array.
  - getElement
```
public java.io.Serializable getElement(int i)
```
    This method returns the specified array element.
    
    Parameters:
    
    i - The array index of the item to be returned (zero origin).
    
    Returns:
    
    The array element at position i.
  - setElement
```
public SerializableTuple setElement(int i,
                                    java.io.Serializable aSerializable)
```
    This method replaces the specified array element with the specified Object.
    
    Parameters:
    
    i - The array index of the item to be replaced (zero origin).
    
    aSerializable - The Object to replace element at position i.
    
    Returns:
    
    This.
  - hashCode
```
public int hashCode()
```
    This method returns the hash code.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The hash code.
    
    See Also:
    
    Object.hashCode().
  - toArray
```
public java.io.Serializable[] toArray()
```
    This method returns a clone of the array.
    
    Returns:
    
    A clone of the array.
  - setArray
```
public SerializableTuple setArray(java.io.Serializable[] aSerializableArray)
```
    This method replaces the array with a clone of the specified array.
    
    Parameters:
    
    aSerializableArray - The specified array.
    
    Returns:
    
    This.
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this object, suitable for printing in trace statements.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of this object.

Methods inherited from class java.lang.Object

COPYRIGHT

SerializableTuple

SerializableTuple

SerializableTuple

SerializableTuple

SerializableTuple

SerializableTuple

SerializableTuple

SerializableTuple

SerializableTuple

equals

getLength

getElement

setElement

hashCode

toArray

setArray

toString