Package io.permazen.encoding

Class StringConvertedEncoding<T>

java.lang.Object

io.permazen.encoding.AbstractEncoding<T>

io.permazen.encoding.ConvertedEncoding<T,String>

io.permazen.encoding.StringConvertedEncoding<T>

Type Parameters:

T - The associated Java type

All Implemented Interfaces:

Encoding<T>, NaturalSortAware, Serializable, Comparator<T>

Direct Known Subclasses:

FileEncoding, InternetAddressEncoding, PatternEncoding, URIEncoding, ZoneIdEncoding

public class StringConvertedEncoding<T>
extends ConvertedEncoding<T,String>

Encoding for any Java type that can be encoded and ordered as a String. A Guava Converter is used to convert between native and String forms.

This class provides a convenient way to implement custom Encodings. Null values are supported and null is the default value. This type will sort instances according to the lexicographical sort order of their String encodings; null will sort last.

See Also:

• ConvertedEncoding
• Serialized Form

Field Summary

Fields inherited from class io.permazen.encoding.AbstractEncoding

encodingId, typeToken

Fields inherited from interface io.permazen.encoding.Encoding

MAX_ARRAY_DIMENSIONS

Constructor Summary

Constructors

Constructor	Description
StringConvertedEncoding(EncodingId encodingId, TypeToken<T> type, Converter<T,String> converter)	Primary constructor.
StringConvertedEncoding(EncodingId encodingId, Class<T> type, Converter<T,String> converter)	Convenience constructor taking Class instead of TypeToken.

Method Summary

Methods inherited from class io.permazen.encoding.ConvertedEncoding

compare, fromString, hasPrefix0x00, hasPrefix0xff, read, skip, sortsNaturally, supportsNull, toString, validate, withEncodingId, write

Methods inherited from class io.permazen.encoding.AbstractEncoding

equals, getDefaultValueObject, getEncodingId, getTypeToken, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface io.permazen.encoding.Encoding

convert, decode, encode, getDefaultValue, getKeyRange, validateAndWrite

Constructor Details

StringConvertedEncoding

public StringConvertedEncoding(EncodingId encodingId,
 TypeToken<T> type,
 Converter<T,String> converter)

Primary constructor.

Parameters:

encodingId - encoding ID for this encoding, or null to be anonymous

type - represented Java type

converter - value converter

Throws:

IllegalArgumentException - if any parameter is null

StringConvertedEncoding

public StringConvertedEncoding(EncodingId encodingId,
 Class<T> type,
 Converter<T,String> converter)

Convenience constructor taking Class instead of TypeToken.

Parameters:

encodingId - encoding ID for this encoding, or null to be anonymous

type - represented Java type

converter - converts between native form and String form; should be Serializable

Throws:

IllegalArgumentException - if any parameter is null