net.openhft.chronicle.wire

Class ShortTextLongConverter

java.lang.Object

net.openhft.chronicle.wire.AbstractLongConverter

net.openhft.chronicle.wire.ShortTextLongConverter

All Implemented Interfaces:

LongConverter

public class ShortTextLongConverter
extends AbstractLongConverter

Implements a Base 85 encoding scheme specifically designed for converting short text strings into long values.

The ShortTextLongConverter is optimized for encoding text strings of up to 10 characters. It efficiently handles leading spaces by truncating them, similar to how Base85LongConverter truncates leading zeros. This feature is particularly useful in scenarios where text padding can be ignored.

This class employs a set of 85 characters, resulting in a more compact representation compared to traditional Base64 encoding, especially for larger data sizes. The custom character set includes a mix of punctuation, numbers, uppercase and lowercase letters, and special characters. This extensive character set ensures a wide range of possible encoded values, enhancing the versatility of the encoding process.

See Also:

AbstractLongConverter, Base85LongConverter

Field Summary

Fields

Modifier and Type	Field and Description
static ShortTextLongConverter	INSTANCE Provides a readily available instance of ShortTextLongConverter for ease of use.
static int	MAX_LENGTH Defines the maximum length of text strings that can be parsed by this converter.

Fields inherited from class net.openhft.chronicle.wire.AbstractLongConverter

converter

Method Summary

Modifier and Type	Method and Description
boolean	allSafeChars() Specifies that not all characters are safe for the given wireOut.
int	maxParseLength() Returns the maximum number of characters that can be parsed.

Methods inherited from class net.openhft.chronicle.wire.AbstractLongConverter

append, append, parse, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.wire.LongConverter

addEncode, allSafeChars, asString, asText, asText, forSymbols, lengthCheck, lengthCheck, maxParseLength

Field Detail

MAX_LENGTH

public static final int MAX_LENGTH

Defines the maximum length of text strings that can be parsed by this converter. The value is set to 10 to optimize for short text strings, making this converter ideal for concise text encoding.

See Also:

Constant Field Values

INSTANCE

public static final ShortTextLongConverter INSTANCE

Provides a readily available instance of ShortTextLongConverter for ease of use. This shared instance allows for convenient access to the converter functionality without the need for repeated instantiations.

Method Detail

maxParseLength

public int maxParseLength()

Returns the maximum number of characters that can be parsed.

Specified by:

maxParseLength in interface LongConverter

Overrides:

maxParseLength in class AbstractLongConverter

Returns:

the maximum length for the parsed string

allSafeChars

public boolean allSafeChars()

Specifies that not all characters are safe for the given wireOut.

Returns:

always false, indicating that caution is required as not all characters are safe for all contexts.