com.timeindexing.index
Class Description

java.lang.Object
  extended bycom.timeindexing.index.Description

public class Description
extends java.lang.Object

This class represents a description which is part of an index header. The description can be any number of bytes, and need not be textual.


Constructor Summary
Description()
          Construct a description.
Description(byte[] theBytes, DataType type)
          Construct a description from a byte[] and a data type.
Description(byte[] theBytes, int type)
          Construct a description from a byte[] and a data type.
Description(java.nio.ByteBuffer buffer, DataType type)
          Construct a description from a ByteBuffer and a data type.
Description(java.nio.ByteBuffer buffer, int type)
          Construct a description from a byte[] and a data type.
Description(java.lang.String desc)
          A text description.
 
Method Summary
 java.nio.ByteBuffer getByteBuffer()
          Get the data s a ByteBuffer.
 byte[] getBytes()
          Get the bytes.
 DataType getDataType()
          Get the data type.
 int length()
          Get the length of the description.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Description

public Description()
Construct a description.


Description

public Description(java.lang.String desc)
A text description.


Description

public Description(byte[] theBytes,
                   int type)
Construct a description from a byte[] and a data type.


Description

public Description(byte[] theBytes,
                   DataType type)
Construct a description from a byte[] and a data type.


Description

public Description(java.nio.ByteBuffer buffer,
                   int type)
Construct a description from a byte[] and a data type.


Description

public Description(java.nio.ByteBuffer buffer,
                   DataType type)
Construct a description from a ByteBuffer and a data type.

Method Detail

getByteBuffer

public java.nio.ByteBuffer getByteBuffer()
Get the data s a ByteBuffer.


getBytes

public byte[] getBytes()
Get the bytes.


getDataType

public DataType getDataType()
Get the data type.


length

public int length()
Get the length of the description.