Uses of Interface
io.permazen.encoding.Encoding

Packages that use Encoding

Package	Description
io.permazen	Abstraction layer allowing access to a Database using normal Java objects.
io.permazen.cli.parse	Permazen parsing related classes.
io.permazen.core	Core classes for the Permazen Java persistence layer.
io.permazen.encoding	Permazen Encodings.

Uses of Encoding in io.permazen

Methods in io.permazen that return Encoding

Modifier and Type	Method	Description
Encoding<?>	PermazenSimpleField.getEncoding()	Get the Encoding used by the core API to encode this field's values.

Uses of Encoding in io.permazen.cli.parse

Constructors in io.permazen.cli.parse with parameters of type Encoding

Modifier	Constructor	Description
	EncodingParser(Encoding<T> encoding)	Constructor.

Uses of Encoding in io.permazen.core

Classes in io.permazen.core that implement Encoding

Modifier and Type	Class	Description
class	EnumValueEncoding	The Encoding for EnumValue, which is the data type used by EnumField.
class	ObjIdEncoding	Non-null encoding for ObjIds.
class	ReferenceEncoding	The Encoding for ReferenceFields.

Methods in io.permazen.core that return Encoding

Modifier and Type	Method	Description
static <T> Encoding<T>	Index.genericize(Encoding<T> encoding)	Genericize the given encoding for use in a index.
Encoding<T>	SimpleField.getEncoding()	Get the Encoding associated with this field.
Encoding<T>	SimpleIndex.getEncoding()	Get the indexed field's encoding.

Methods in io.permazen.core that return types with arguments of type Encoding

Modifier and Type	Method	Description
List<Encoding<?>>	AbstractCoreIndex.getEncodings()	Get all of the Encodings associated with this instance.
List<Encoding<?>>	Index.getEncodings()	Get the field encoding(s).

Methods in io.permazen.core with parameters of type Encoding

Modifier and Type	Method	Description
<S> ObjId	ReferenceEncoding.convert(Encoding<S> type, S value)	Attempt to convert a value from the given Encoding into a value of this Encoding.
static <T> Encoding<T>	Index.genericize(Encoding<T> encoding)	Genericize the given encoding for use in a index.

Uses of Encoding in io.permazen.encoding

Classes in io.permazen.encoding that implement Encoding

Modifier and Type	Class	Description
class	AbstractEncoding<T>	Support superclass for Encoding implementations.
class	ArrayEncoding<T,E>	Support superclass for built-in array Encodings.
class	Base64ArrayEncoding<T,E>	Adds support for an alternate Base-64 String encoding for primitive array types.
class	BigDecimalEncoding	Non-null BigDecimal type.
class	BigIntegerEncoding	Non-null BigInteger type.
class	BitSetEncoding	Non-null BitSet type.
class	BooleanArrayEncoding	boolean[] array type.
class	BooleanEncoding
class	ByteArrayEncoding	byte[] primitive array type.
class	ByteEncoding	byte primitive type.
class	CharacterArrayEncoding	char[] array type.
class	CharacterEncoding	Character type.
class	ConvertedEncoding<T,S>	An Encoding that relies on some other Encoding, converting values to/from the other Encoding's Java type.
class	DateEncoding	Non-null Date type.
class	DoubleArrayEncoding	double[] array type.
class	DoubleEncoding	Double type.
class	DurationEncoding	Non-null Duration type.
class	FileEncoding	File type.
class	FloatArrayEncoding	float[] array type.
class	FloatEncoding	Float type.
class	Inet4AddressEncoding	Non-null Inet4Address type.
class	Inet6AddressEncoding	Non-null Inet6Address type.
class	InetAddressEncoding	Non-null InetAddress type.
class	InstantEncoding	Non-null Instant type.
class	IntegerArrayEncoding	int[] primitive array type.
class	IntegerEncoding	int primitive type.
class	IntegralArrayEncoding<T,E extends Number>	Array type for integral primitive element types.
class	IntegralEncoding<T extends Number>	Support superclass for the integral types encoded via LongEncoder.
class	InternetAddressEncoding	InternetAddress email address encoding.
class	LocalDateEncoding	Non-null LocalDate type.
class	LocalDateTimeEncoding	Non-null LocalDateTime type.
class	LocalTimeEncoding	Non-null LocalTime type.
class	LongArrayEncoding	long[] primitive array type.
class	LongEncoding	Long type.
class	MonthDayEncoding	Non-null MonthDay type.
class	NullSafeEncoding<T>	An Encoding that wraps any other Encoding not supporting null values and adds support for null values.
class	NumberEncoding<T extends Number>	Support superclass for the numeric primitive types.
class	ObjectArrayEncoding<E>	Array type for object arrays having non-primitive element types.
class	OffsetDateTimeEncoding	Non-null OffsetDateTime type.
class	OffsetTimeEncoding	Non-null OffsetTime type.
class	PatternEncoding	Pattern type.
class	PeriodEncoding	Non-null Period type.
class	PrimitiveEncoding<T>	Support superclass for built-in primitive type encodings.
class	PrimitiveWrapperEncoding<T>	Primitive wrapper type.
class	ShortArrayEncoding	short[] primitive array type.
class	ShortEncoding	Short type.
class	StringConvertedEncoding<T>	Encoding for any Java type that can be encoded and ordered as a String.
class	StringEncoding	Non-null String encoding.
class	Tuple2Encoding<V1,V2>	Composite encoding constructed from the concatenation of two component encodings.
class	Tuple3Encoding<V1,V2,V3>	Composite encoding constructed from the concatenation of three component encodings.
class	Tuple4Encoding<V1,V2,V3,V4>	Composite encoding constructed from the concatenation of four component encodings.
class	Tuple5Encoding<V1,V2,V3,V4,V5>	Composite encoding constructed from the concatenation of five component encodings.
class	TupleEncoding<T extends Tuple>	Superclass for Encodings created from the concatenation of other Encodings.
class	UnsignedIntEncoding	Encoding for unsigned int values in the manner of UnsignedIntEncoder.
class	URIEncoding	URI type.
class	UUIDEncoding	Non-null UUID type.
class	VoidEncoding	void primitive type.
class	YearEncoding	Non-null Year type.
class	YearMonthEncoding	Non-null YearMonth type.
class	ZonedDateTimeEncoding	Non-null ZonedDateTime type.
class	ZoneIdEncoding	ZoneId type.
class	ZoneOffsetEncoding	Non-null ZoneOffset type.

Fields in io.permazen.encoding declared as Encoding

Modifier and Type	Field	Description
protected final Encoding<T>	NullSafeEncoding.inner	The inner Encoding that this instance wraps.
protected final Encoding<S1>	Concat2Encoding.type1
protected final Encoding<S1>	Concat2Encoding.type1
protected final Encoding<S1>	Concat2Encoding.type1
protected final Encoding<S2>	Concat2Encoding.type2
protected final Encoding<S2>	Concat2Encoding.type2
protected final Encoding<S2>	Concat2Encoding.type2

Methods in io.permazen.encoding that return Encoding

Modifier and Type	Method	Description
static <E> Encoding<E[]>	SimpleEncodingRegistry.buildArrayEncoding(Encoding<E> elementEncoding)	Build an array encoding for the given element encoding using Permazen's default array encoding.
Encoding<E>	ArrayEncoding.getElementEncoding()	Get the element type.
Encoding<?>	DefaultEncodingRegistry.getEncoding(EncodingId encodingId)
default <T> Encoding<T>	EncodingRegistry.getEncoding(TypeToken<T> typeToken)	Get the unique Encoding in this registry that supports values of the given Java type.
Encoding<?>	EncodingRegistry.getEncoding(EncodingId encodingId)	Get the Encoding with the given encoding ID in this registry.
Encoding<?>	SimpleEncodingRegistry.getEncoding(EncodingId encodingId)
Encoding<T>	NullSafeEncoding.getInnerEncoding()	Get the inner Encoding that this instance wraps.
Encoding<T>	Encoding.withEncodingId(EncodingId encodingId)	Build an encoding that has the given EncodingId but is otherwise equivalent to this encoding.

Methods in io.permazen.encoding that return types with arguments of type Encoding

Modifier and Type	Method	Description
<T> List<Encoding<T>>	DefaultEncodingRegistry.getEncodings(TypeToken<T> typeToken)
<T> List<Encoding<T>>	EncodingRegistry.getEncodings(TypeToken<T> typeToken)	Get all of the Encodings in this registry that supports values of the given Java type.
<T> List<Encoding<T>>	SimpleEncodingRegistry.getEncodings(TypeToken<T> typeToken)

Methods in io.permazen.encoding with parameters of type Encoding

Modifier and Type	Method	Description
boolean	SimpleEncodingRegistry.add(Encoding<?> encoding)	Add a new Encoding to this registry.
static <E> Encoding<E[]>	SimpleEncodingRegistry.buildArrayEncoding(Encoding<E> elementEncoding)	Build an array encoding for the given element encoding using Permazen's default array encoding.
<S> T	ArrayEncoding.convert(Encoding<S> type, S value)
<S> char[]	CharacterArrayEncoding.convert(Encoding<S> type, S value)
<S> Character	CharacterEncoding.convert(Encoding<S> type, S value)
default <S> T	Encoding.convert(Encoding<S> encoding, S value)	Attempt to convert a value from the given Encoding into a value of this Encoding.
<S> T	NullSafeEncoding.convert(Encoding<S> type, S value)
<S> T	PrimitiveEncoding.convert(Encoding<S> type, S value)
<S> String	StringEncoding.convert(Encoding<S> type, S value)
protected void	SimpleEncodingRegistry.register(EncodingId encodingId, Encoding<?> encoding)	Register a new Encoding.

Method parameters in io.permazen.encoding with type arguments of type Encoding

Modifier and Type	Method	Description
protected void	DefaultEncodingRegistry.addOptionalBuiltinEncoding(String name, Function<EncodingId,? extends Encoding<?>> builder)	Register a built-in encoding, but only if its target class is found on the classpath.

Constructors in io.permazen.encoding with parameters of type Encoding

Modifier	Constructor	Description
protected	ArrayEncoding(EncodingId encodingId, Encoding<E> elementEncoding, TypeToken<T> typeToken)	Constructor.
	ConvertedEncoding(EncodingId encodingId, TypeToken<T> typeToken, T defaultValue, Encoding<S> delegate, Converter<T,S> converter, boolean sortsNaturally)	Primary constructor.
	ConvertedEncoding(EncodingId encodingId, Class<T> type, T defaultValue, Encoding<S> delegate, Converter<T,S> converter, boolean sortsNaturally)	Convenience constructor taking Class instead of TypeToken.
	NullSafeEncoding(EncodingId encodingId, Encoding<T> inner)	Constructor.
	ObjectArrayEncoding(EncodingId encodingId, Encoding<E> elementEncoding)
	Tuple2Encoding(EncodingId encodingId, Encoding<V1> value1Encoding, Encoding<V2> value2Encoding)	Constructor.
	Tuple3Encoding(EncodingId encodingId, Encoding<V1> value1Encoding, Encoding<V2> value2Encoding, Encoding<V3> value3Encoding)	Constructor.
	Tuple4Encoding(EncodingId encodingId, Encoding<V1> value1Encoding, Encoding<V2> value2Encoding, Encoding<V3> value3Encoding, Encoding<V4> value4Encoding)	Constructor.
	Tuple5Encoding(EncodingId encodingId, Encoding<V1> value1Encoding, Encoding<V2> value2Encoding, Encoding<V3> value3Encoding, Encoding<V4> value4Encoding, Encoding<V5> value5Encoding)	Constructor.
protected	TupleEncoding(EncodingId encodingId, TypeToken<T> typeToken, Encoding<?>... encodings)	Constructor.