Package com.helger.base.codec.impl

Class LZWCodec.LZWEncodeDictionary

java.lang.Object

com.helger.base.codec.impl.LZWCodec.AbstractLZWDictionary

com.helger.base.codec.impl.LZWCodec.LZWEncodeDictionary

Enclosing class:

LZWCodec

protected static class LZWCodec.LZWEncodeDictionary
extends LZWCodec.AbstractLZWDictionary

Field Summary

Fields inherited from class com.helger.base.codec.impl.LZWCodec.AbstractLZWDictionary

CODE_CLEARTABLE, CODE_EOF, m_aTab, m_nCodeBits, m_nFreeCode, MAX_CODE

Constructor Summary

Constructors

Constructor	Description
LZWEncodeDictionary()	Constructor.

Method Summary

Modifier and Type	Method	Description
int	getCodeLength()
@Nullable LZWCodec.LZWNode	getNode(byte @NonNull [] aBytes)	Get the node in the encoding tree corresponding to the provided byte sequence.
void	reset()	Reset this dictionary to its initial state, clearing all entries and re-initializing with the 256 single-byte entries.
boolean	visit(byte nByteToVisit)	Visit a single byte during the encoding process.

Methods inherited from class com.helger.base.codec.impl.LZWCodec.AbstractLZWDictionary

addEntry, getNextFreeCode

Methods inherited from class java.lang.Object

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

Constructor Details

LZWEncodeDictionary

public LZWEncodeDictionary()

Constructor.

Method Details

reset

public void reset()

Description copied from class: LZWCodec.AbstractLZWDictionary

Reset this dictionary to its initial state, clearing all entries and re-initializing with the 256 single-byte entries.

Overrides:

reset in class LZWCodec.AbstractLZWDictionary

getCodeLength

public int getCodeLength()

Returns:

The current code length in bits used for encoding.

visit

public boolean visit(byte nByteToVisit)

Visit a single byte during the encoding process. If a new byte sequence is found that is not yet in the dictionary, it is added.

Parameters:

nByteToVisit - The byte to process.

Returns:

true if a new entry was added to the dictionary, false otherwise.

getNode

public @Nullable LZWCodec.LZWNode getNode(byte @NonNull [] aBytes)

Get the node in the encoding tree corresponding to the provided byte sequence.

Parameters:

aBytes - The byte sequence to look up. May not be null.

Returns:

The corresponding node, or null if no such node exists.