IndexValue (soss-jnc-5.10 API)

java.lang.Object
- com.scaleoutsoftware.soss.client.IndexValue

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public final class IndexValue
extends java.lang.Object
implements java.io.Externalizable
```
An immutable value that may be assigned to an IndexCollection and used to query the StateServer for objects with metadata matching the IndexCollection.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MaxValueByteLength

Fields
Modifier and Type	Field and Description
`static int`	`MaxValueByteLength`

Constructor Summary

Constructors
Constructor and Description
`IndexValue(boolean value)` Create a new `IndexValue` using the contents of value exported as a byte array.
`IndexValue(byte[] value)` Create a new `IndexValue` with the value given in value.
`IndexValue(byte[] value, int position, int length)` Create a new `IndexValue` with the values given in positions position (inclusive) through position + length (exclusive) of the array value.
`IndexValue(java.util.Date value)` Create a new `IndexValue` using the contents of value exported as a byte array.
`IndexValue(int value)` Create a new `IndexValue` using the contents of value exported as a byte array.
`IndexValue(long value)` Create a new `IndexValue` using the contents of value exported as a byte array.
`IndexValue(java.lang.String value)` Create a new `IndexValue` using the 32-byte digest resulting from the SHA-256 `MessageDigest` of value.
`IndexValue(java.util.UUID value)` Create a new `IndexValue` using the contents of value exported as a byte array.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`CopyTo(byte[] dest, int index)` Copies the contents of this `IndexValue` to the specified byte array beginning at the specified index.
`static IndexValue`	`deserialize(java.io.ObjectInput in)` Create a new `IndexValue` instance from the serialized stream given by in.
`boolean`	`equals(java.lang.Object obj)`
`byte[]`	`getBytes()` Returns a copy of the current value of this `IndexValue` as an array of bytes.
`int`	`hashCode()`
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`writeExternal(java.io.ObjectOutput out)`

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

- Field Detail
  - MaxValueByteLength
```
public static final int MaxValueByteLength
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IndexValue
```
public IndexValue(boolean value)
```
    Create a new IndexValue using the contents of value exported as a byte array.
    
    Parameters:
    
    value - the value from which the IndexValue is created.
  - IndexValue
```
public IndexValue(java.util.Date value)
```
    Create a new IndexValue using the contents of value exported as a byte array.
    
    Parameters:
    
    value - the value from which the IndexValue is created.
  - IndexValue
```
public IndexValue(java.util.UUID value)
```
    Create a new IndexValue using the contents of value exported as a byte array.
    
    Parameters:
    
    value - the value from which the IndexValue is created.
  - IndexValue
```
public IndexValue(int value)
```
    Create a new IndexValue using the contents of value exported as a byte array.
    
    Parameters:
    
    value - the value from which the IndexValue is created.
  - IndexValue
```
public IndexValue(long value)
```
    Create a new IndexValue using the contents of value exported as a byte array.
    
    Parameters:
    
    value - the value from which the IndexValue is created.
  - IndexValue
```
public IndexValue(java.lang.String value)
```
    Create a new IndexValue using the 32-byte digest resulting from the SHA-256 MessageDigest of value.
    
    Parameters:
    
    value - the value from which the IndexValue is created.
  - IndexValue
```
public IndexValue(byte[] value)
```
    Create a new IndexValue with the value given in value. Note that StateServer does not differentiate IndexValues based on the length of the index value: IndexValues are always padded with zeros so that the IndexValue is a full MaxValueByteLength in length.
    
    Parameters:
    
    value - a byte array that is first cloned and then the clone is used to initialize the new IndexValue. The length of value must be less than or equal to MaxValueByteLength.
    
    Throws:
    
    java.lang.NullPointerException - if value is null.
    
    java.lang.IllegalArgumentException - if value.length > MaxValueByteLength.
  - IndexValue
```
public IndexValue(byte[] value,
                  int position,
                  int length)
```
    Create a new IndexValue with the values given in positions position (inclusive) through position + length (exclusive) of the array value. Note that StateServer does not differentiate IndexValues based on the length of the index value: IndexValues are always padded with zeros so that the IndexValue is a full MaxValueByteLength in length.
    
    Parameters:
    
    value - a byte array from which bytes are copied to initialize the new IndexValue.
    
    position - the starting position within value from which bytes are copied
    
    length - the number of bytes to copy. length must be less or equal to MaxValueByteLength.
    
    Throws:
    
    java.lang.NullPointerException - if value is null.
    
    java.lang.IllegalArgumentException - if length > MaxValueByteLength.
- Method Detail
  - CopyTo
```
public void CopyTo(byte[] dest,
                   int index)
```
    Copies the contents of this IndexValue to the specified byte array beginning at the specified index.
    
    Parameters:
    
    dest - the destination byte array
    
    index - the index at which copying begins
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if copying would cause access of data outside array bounds.
    
    java.lang.NullPointerException - if dest is null.
  - getBytes
```
public byte[] getBytes()
```
    Returns a copy of the current value of this IndexValue as an array of bytes.
    
    Returns:
    
    a copy of the current value of this IndexValue as an array of bytes.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - deserialize
```
public static IndexValue deserialize(java.io.ObjectInput in)
                              throws java.io.IOException
```
    Create a new IndexValue instance from the serialized stream given by in.
    
    Parameters:
    
    in - an ObjectInput stream containing the bytes previously serialized via writeExternal(ObjectOutput)
    
    Returns:
    
    an IndexValue instance initialized from the stream
    
    Throws:
    
    java.io.IOException - if there are issues accessing the ObjectInput stream
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException

Class IndexValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MaxValueByteLength

Constructor Detail

IndexValue

IndexValue

IndexValue

IndexValue

IndexValue

IndexValue

IndexValue

IndexValue

Method Detail

CopyTo

getBytes

hashCode

equals

deserialize

readExternal

writeExternal