Package io.permazen.encoding

Class Base64ArrayEncoding<T,E>

java.lang.Object

io.permazen.encoding.AbstractEncoding<T>

io.permazen.encoding.ArrayEncoding<T,E>

io.permazen.encoding.Base64ArrayEncoding<T,E>

Type Parameters:

T - array type

E - array element type

All Implemented Interfaces:

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

Direct Known Subclasses:

DoubleArrayEncoding, FloatArrayEncoding, IntegralArrayEncoding

public abstract class Base64ArrayEncoding<T,E>
extends ArrayEncoding<T,E>

Adds support for an alternate Base-64 String encoding for non-null primitive array types.

Null values are not supported by this class and there is no default value.

See Also:

• 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

Modifier	Constructor	Description
protected	Base64ArrayEncoding(PrimitiveEncoding<E> elementEncoding, TypeToken<T> typeToken)

Method Summary

Modifier and Type	Method	Description
protected T	checkDecodeLength(int numBytes)
protected abstract T	decode(DataInputStream input, int numBytes)
protected abstract void	encode(T array, DataOutputStream output)
T	fromString(String string)	Parse a non-null value previously encoded by toString(T).
String	toString(T array)	Encode a non-null value as a String for later decoding by fromString().
String	toString(T array, boolean base64)	Encode a non-null value as a String for later decoding by fromString().
protected boolean	useBase64Encoding(T array)	Invoked by toString(T) to determine whether to encode using base 64 or not.

Methods inherited from class io.permazen.encoding.ArrayEncoding

compare, convert, createArray, equals, fromArrayString, getArrayElement, getArrayLength, getElementEncoding, getFixedWidth, hashCode, sortsNaturally, supportsNull, toArrayString

Methods inherited from class io.permazen.encoding.AbstractEncoding

getDefaultValue, getDefaultValueBytes, getEncodingId, getTypeToken, 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

decode, encode, getKeyRange, hasPrefix0x00, hasPrefix0xff, read, skip, validate, validateAndWrite, write

Constructor Details

Base64ArrayEncoding

protected Base64ArrayEncoding(PrimitiveEncoding<E> elementEncoding,
 TypeToken<T> typeToken)

Method Details

fromString

public T fromString(String string)

Description copied from interface: Encoding

Parse a non-null value previously encoded by toString(T).

Specified by:

fromString in interface Encoding<T>

Overrides:

fromString in class ArrayEncoding<T,E>

Parameters:

string - non-null value previously encoded as a String by toString(T)

Returns:

actual value

toString

public String toString(T array)

Description copied from interface: Encoding

Encode a non-null value as a String for later decoding by fromString().

Each of the characters in the returned String, when decoded as 32-bit Unicode codepoints, must contain only valid XML characters (see XMLUtil.isValidChar(int)).

Specified by:

toString in interface Encoding<T>

Overrides:

toString in class ArrayEncoding<T,E>

Parameters:

array - actual value, never null

Returns:

string encoding of value acceptable to fromString()

See Also:

• The XML 1.0 Specification

toString

public String toString(T array,
 boolean base64)

Encode a non-null value as a String for later decoding by fromString().

Parameters:

array - array to encode

base64 - true for base 64 synax, false for standard syntax

Returns:

string encoding of value acceptable to fromString()

Throws:

IllegalArgumentException - if value is null

useBase64Encoding

protected boolean useBase64Encoding(T array)

Invoked by toString(T) to determine whether to encode using base 64 or not.

The implementation in Base64ArrayEncoding rerturns true for arrays longer than 16 elements.

Parameters:

array - array to be encoded, never null

Returns:

true for base 64 encoding, otherwise false

encode

protected abstract void encode(T array,
 DataOutputStream output)
                        throws IOException

Throws:

IOException

decode

protected abstract T decode(DataInputStream input,
 int numBytes)
                     throws IOException

Throws:

IOException

checkDecodeLength

protected T checkDecodeLength(int numBytes)