Package com.googlecode.javaewah

Class RunningLengthWord

java.lang.Object

com.googlecode.javaewah.RunningLengthWord

All Implemented Interfaces:

java.lang.Cloneable

public final class RunningLengthWord
extends java.lang.Object
implements java.lang.Cloneable

Mostly for internal use.

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Buffer	buffer	The array of words.
static int	LARGEST_LITERAL_COUNT	largest number of literal words in a run.
static long	LARGEST_RUNNING_LENGTH_COUNT	largest number of clean words in a run
private static int	LITERAL_BITS
private static long	NOT_RUNNING_LENGTH_PLUS_RUNNING_BIT
private static long	NOT_SHIFTED_LARGEST_RUNNING_LENGTH_COUNT
(package private) int	position	The position in array.
static int	RUNNING_LENGTH_BITS	number of bits dedicated to marking of the running length of clean words
private static long	RUNNING_LENGTH_PLUS_RUNNING_BIT
private static long	SHIFTED_LARGEST_RUNNING_LENGTH_COUNT

Constructor Summary

Constructors

Constructor	Description
RunningLengthWord(Buffer buffer, int p)	Instantiates a new running length word.

Method Summary

Modifier and Type	Method	Description
RunningLengthWord	clone()
int	getNumberOfLiteralWords()	Gets the number of literal words.
(package private) static int	getNumberOfLiteralWords(Buffer buffer, int position)
boolean	getRunningBit()	Gets the running bit.
(package private) static boolean	getRunningBit(Buffer buffer, int position)
long	getRunningLength()	Gets the running length.
(package private) static long	getRunningLength(Buffer buffer, int position)
void	setNumberOfLiteralWords(long number)	Sets the number of literal words.
(package private) static void	setNumberOfLiteralWords(Buffer buffer, int position, long number)
void	setRunningBit(boolean b)	Sets the running bit.
(package private) static void	setRunningBit(Buffer buffer, int position, boolean b)
void	setRunningLength(long number)	Sets the running length.
(package private) static void	setRunningLength(Buffer buffer, int position, long number)
long	size()	Return the size in uncompressed words represented by this running length word.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

buffer

final Buffer buffer

The array of words.

position

int position

The position in array.

RUNNING_LENGTH_BITS

public static final int RUNNING_LENGTH_BITS

number of bits dedicated to marking of the running length of clean words

See Also:

Constant Field Values

LITERAL_BITS

private static final int LITERAL_BITS

See Also:

Constant Field Values

LARGEST_LITERAL_COUNT

public static final int LARGEST_LITERAL_COUNT

largest number of literal words in a run.

See Also:

Constant Field Values

LARGEST_RUNNING_LENGTH_COUNT

public static final long LARGEST_RUNNING_LENGTH_COUNT

largest number of clean words in a run

See Also:

Constant Field Values

RUNNING_LENGTH_PLUS_RUNNING_BIT

private static final long RUNNING_LENGTH_PLUS_RUNNING_BIT

See Also:

Constant Field Values

SHIFTED_LARGEST_RUNNING_LENGTH_COUNT

private static final long SHIFTED_LARGEST_RUNNING_LENGTH_COUNT

See Also:

Constant Field Values

NOT_RUNNING_LENGTH_PLUS_RUNNING_BIT

private static final long NOT_RUNNING_LENGTH_PLUS_RUNNING_BIT

See Also:

Constant Field Values

NOT_SHIFTED_LARGEST_RUNNING_LENGTH_COUNT

private static final long NOT_SHIFTED_LARGEST_RUNNING_LENGTH_COUNT

See Also:

Constant Field Values

Constructor Detail

RunningLengthWord

RunningLengthWord(Buffer buffer,
                  int p)

Instantiates a new running length word.

Parameters:

buffer - the buffer

p - position in the buffer where the running length word is located.

Method Detail

getNumberOfLiteralWords

public int getNumberOfLiteralWords()

Gets the number of literal words.

Returns:

the number of literal words

getNumberOfLiteralWords

static int getNumberOfLiteralWords(Buffer buffer,
                                   int position)

getRunningBit

public boolean getRunningBit()

Gets the running bit.

Returns:

the running bit

getRunningBit

static boolean getRunningBit(Buffer buffer,
                             int position)

getRunningLength

public long getRunningLength()

Gets the running length.

Returns:

the running length

getRunningLength

static long getRunningLength(Buffer buffer,
                             int position)

setNumberOfLiteralWords

public void setNumberOfLiteralWords(long number)

Sets the number of literal words.

Parameters:

number - the new number of literal words

setNumberOfLiteralWords

static void setNumberOfLiteralWords(Buffer buffer,
                                    int position,
                                    long number)

setRunningBit

public void setRunningBit(boolean b)

Sets the running bit.

Parameters:

b - the new running bit

setRunningBit

static void setRunningBit(Buffer buffer,
                          int position,
                          boolean b)

setRunningLength

public void setRunningLength(long number)

Sets the running length.

Parameters:

number - the new running length

setRunningLength

static void setRunningLength(Buffer buffer,
                             int position,
                             long number)

size

public long size()

Return the size in uncompressed words represented by this running length word.

Returns:

the size

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public RunningLengthWord clone()
                        throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException