net.openhft.chronicle.wire.converter

Annotation Type ShortText

@Retention(value=RUNTIME)
 @Target(value={FIELD,PARAMETER})
public @interface ShortText

Annotation to indicate that a given field or parameter, represented as a long value, should be treated as a string containing 0 to 10 characters in Base85 format. This truncated leading spaces, but preserves leading zero c.f. Base85

Base85, also known as Ascii85, is a binary-to-ASCII encoding scheme that provides an efficient way to encode binary data for transport over text-based protocols.

When this annotation is applied to a field or parameter, it provides a hint about the expected format and representation of the data, allowing for potential encoding and decoding operations based on Base85.

The provided INSTANCE is a default converter that can be used for operations relevant to the Base85 format. Usage Example:

  @ShortText
 private long encodedText;
 

See Also:

LongConverter, Base85, ShortTextLongConverter

Field Detail

INSTANCE

public static final LongConverter INSTANCE

An instance of ShortTextLongConverter specifically configured for Base85 conversions. This converter uses a character set defined by the ShortTextLongConverter to represent Base85 encoded data.