LongConverter (OpenHFT/Chronicle-Wire 2.26ea3 API)

All Known Implementing Classes:

AbstractLongConverter, AbstractTimestampLongConverter, Base32LongConverter, Base64LongConverter, Base85LongConverter, HexadecimalLongConverter, IdentifierLongConverter, MicroDurationLongConverter, MicroTimestampLongConverter, MilliTimestampLongConverter, NanoDurationLongConverter, NanoTimestampLongConverter, PowerOfTwoLongConverter, ServicesTimestampLongConverter, ShortTextLongConverter, SizeLongConverter, SymbolsLongConverter, WordsLongConverter
```
public interface LongConverter
```
Provides an abstraction for converting between long values and their string representations, potentially based on a custom character or symbol set.
The conversion allows encoding long values into compact, human-readable strings and vice versa, useful in contexts where storage efficiency or readability is a concern.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default void`	`addEncode(char alias, char as)` Introduces a character alias for encoding, facilitating the interpretation of one character as another during encoding.
`default boolean`	`allSafeChars()` Checks if the characters used are "safe", meaning they don't require additional quoting or escaping, especially in contexts like YAML serialization.
`default boolean`	`allSafeChars(WireOut wireOut)` Deprecated.
`default void`	`append(net.openhft.chronicle.bytes.Bytes<?> bytes, long value)` Converts the given long value to a string and appends it to the provided Bytes object.
`void`	`append(StringBuilder text, long value)` Converts the given long value to a string and appends it to the provided StringBuilder.
`default String`	`asString(long value)` Converts the given long value to a string.
`default CharSequence`	`asText(int value)` Converts the provided integer value to a CharSequence representation.
`default CharSequence`	`asText(long value)` Converts the provided long value to a CharSequence representation.
`static LongConverter`	`forSymbols(String chars)` Creates an instance of the appropriate implementation of based on the length of the provided character set.
`default void`	`lengthCheck(CharSequence text)` Checks that the length of the provided text does not exceed the allowable maximum.
`default void`	`lengthCheck(CharSequence text, int beginIndex, int endIndex)` Checks that the length of the provided text does not exceed the allowable maximum.
`default int`	`maxParseLength()` Returns the maximum number of characters that this converter can parse.
`static int`	`maxParseLength(int based)` Calculates the maximum length of a parsed string based on the provided base.
`long`	`parse(CharSequence text)` Parses the provided `CharSequence` and returns the parsed results as a `long` primitive.
`default long`	`parse(CharSequence text, int beginIndex, int endIndex)` Parses a part of the provided `CharSequence` and returns the parsed results as a `long` primitive.

- Method Detail
  - forSymbols
```
static LongConverter forSymbols(String chars)
```
    Creates an instance of the appropriate implementation of based on the length of the provided character set.
    
    Parameters:
    
    chars - A set of symbols or characters to be used in the conversion.
    
    Returns:
    
    An instance of . If the length of chars is a power of 2, a PowerOfTwoLongConverter is returned; otherwise, a SymbolsLongConverter is returned.
  - maxParseLength
```
static int maxParseLength(int based)
```
    Calculates the maximum length of a parsed string based on the provided base.
    
    Parameters:
    
    based - The base for conversion.
    
    Returns:
    
    The maximum length a string can have to represent a long value.
  - parse
```
long parse(CharSequence text)
```
    Parses the provided CharSequence and returns the parsed results as a long primitive.
    
    Returns:
    
    the parsed text as an long primitive.
    
    Throws:
    
    IllegalArgumentException - if the text length is outside of range accepted by a specific converter.
  - parse
```
default long parse(CharSequence text,
                   int beginIndex,
                   int endIndex)
```
    Parses a part of the provided CharSequence and returns the parsed results as a long primitive.
    The default implementation is garbage-producing and an implementing class is supposed to reimplement this method.
    
    Parameters:
    
    text - character sequence containing the string representation of the value.
    
    beginIndex - the beginning index, inclusive.
    
    endIndex - the ending index, exclusive.
    
    Returns:
    
    the parsed text as an long primitive.
    
    Throws:
    
    IllegalArgumentException - if any of the indices are invalid or the sub-sequence length is outside of range accepted by a specific converter.
  - append
```
void append(StringBuilder text,
            long value)
```
    Converts the given long value to a string and appends it to the provided StringBuilder.
    
    Parameters:
    
    text - The StringBuilder to which the converted value is appended.
    
    value - The long value to convert.
  - append
```
default void append(net.openhft.chronicle.bytes.Bytes<?> bytes,
                    long value)
```
    Converts the given long value to a string and appends it to the provided Bytes object.
    
    Parameters:
    
    bytes - The Bytes object to which the converted value is appended.
    
    value - The long value to convert.
  - asString
```
default String asString(long value)
```
    Converts the given long value to a string.
    
    Parameters:
    
    value - The long value to convert.
    
    Returns:
    
    The string representation of the value.
  - asText
```
default CharSequence asText(int value)
```
    Converts the provided integer value to a CharSequence representation.
    
    Parameters:
    
    value - The integer value to convert.
    
    Returns:
    
    The CharSequence representation of the value.
  - asText
```
default CharSequence asText(long value)
```
    Converts the provided long value to a CharSequence representation.
    
    Parameters:
    
    value - The long value to convert.
    
    Returns:
    
    The CharSequence representation of the value.
  - maxParseLength
```
default int maxParseLength()
```
    Returns the maximum number of characters that this converter can parse.
    
    Returns:
    
    The maximum parse length, or Integer.MAX_VALUE if there's no limit.
  - lengthCheck
```
default void lengthCheck(CharSequence text)
```
    Checks that the length of the provided text does not exceed the allowable maximum.
    
    Parameters:
    
    text - The text to check.
    
    Throws:
    
    IllegalArgumentException - if the text length exceeds the maximum allowable length.
  - lengthCheck
```
default void lengthCheck(CharSequence text,
                         int beginIndex,
                         int endIndex)
```
    Checks that the length of the provided text does not exceed the allowable maximum.
    
    Parameters:
    
    text - The text to check.
    
    beginIndex - the beginning index, inclusive.
    
    endIndex - the ending index, exclusive.
    
    Throws:
    
    IllegalArgumentException - if the text length exceeds the maximum allowable length.
  - allSafeChars
```
@Deprecated
default boolean allSafeChars(WireOut wireOut)
```
    Deprecated.
    
    Checks if the characters in the provided WireOut object are "safe", meaning they don't require additional quoting or escaping, especially in contexts like YAML serialization.
    
    Parameters:
    
    wireOut - The WireOut instance to check.
    
    Returns:
    
    true if no characters need escaping or additional quoting for YAML, false otherwise.
  - allSafeChars
```
default boolean allSafeChars()
```
    Checks if the characters used are "safe", meaning they don't require additional quoting or escaping, especially in contexts like YAML serialization.
    
    Returns:
    
    true if no characters need escaping or additional quoting for JSON or YAML, false otherwise.
  - addEncode
```
default void addEncode(char alias,
                       char as)
```
    Introduces a character alias for encoding, facilitating the interpretation of one character as another during encoding.
    
    Parameters:
    
    alias - The character to treat as an alias.
    
    as - The character that the alias should be treated as.
    
    Throws:
    
    UnsupportedOperationException - If the operation is not supported.

Interface LongConverter

Method Summary

Method Detail

forSymbols

maxParseLength

parse

parse

append

append

asString

asText

asText

maxParseLength

lengthCheck

lengthCheck

allSafeChars

allSafeChars

addEncode