io.permazen.core.type

Class StringEncodedType<T>

java.lang.Object

io.permazen.core.FieldType<T>

io.permazen.core.type.NullSafeType<T>

io.permazen.core.type.StringEncodedType<T>

Type Parameters:

T - The associated Java type

All Implemented Interfaces:

Serializable, Comparator<T>

Direct Known Subclasses:

FileType, InternetAddressType, PatternType, URIType, ZoneIdType

public class StringEncodedType<T>
extends NullSafeType<T>

A FieldType implementation for any Java type that can be encoded uniquely as a String. A Converter is used to convert between native and String forms.

This class provides a convenient way to implement custom FieldTypes. 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.

The supplied Converter must be Serializable in order for an instance of this class to also be Serializable.

See Also:

Serialized Form

Field Summary

Fields inherited from class io.permazen.core.type.NullSafeType

inner, NOT_NULL_SENTINEL, NULL_SENTINEL

Fields inherited from class io.permazen.core.FieldType

name, NAME_PATTERN, REFERENCE_TYPE_NAME, signature, typeToken

Constructor Summary

Constructors

Constructor and Description
StringEncodedType(Class<T> type, long signature, Converter<T,String> converter) Convenience constructor.
StringEncodedType(String name, Class<T> type, long signature, Converter<T,String> converter) Primary constructor.

Method Summary

Methods inherited from class io.permazen.core.type.NullSafeType

compare, convert, equals, fromParseableString, fromString, genericizeForIndex, getInnerType, hashCode, hasPrefix0x00, hasPrefix0xff, read, skip, toParseableString, toString, write

Methods inherited from class io.permazen.core.FieldType

getDefaultValue, getDefaultValueObject, getEncodingSignature, getKeyRange, getName, getTypeToken, toString, validate, validateAndWrite

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

StringEncodedType

public StringEncodedType(Class<T> type,
                         long signature,
                         Converter<T,String> converter)

Convenience constructor. Uses the name of the type as this FieldType's type name.

Parameters:

type - represented Java type

signature - binary encoding signature (in this case, String encoding signature)

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

Throws:

IllegalArgumentException - if converter does not convert null to null

IllegalArgumentException - if any parameter is null

StringEncodedType

public StringEncodedType(String name,
                         Class<T> type,
                         long signature,
                         Converter<T,String> converter)

Primary constructor.

Parameters:

name - the name for this FieldType

type - represented Java type

signature - binary encoding signature (in this case, String encoding signature)

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

Throws:

IllegalArgumentException - if converter does not convert null to null

IllegalArgumentException - if any parameter is null