Index

A B C D E F H I K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages

A

acceptElement(C, E) - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder.DecodeProcessor
Accepts the element to the identity object of ElementDecoder.DecodeProcessor.
acceptEntry(T, K, V) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
Accepts the key-value entry to the identity object of EntryProcessor.
actualType() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.TypeMismatch
Gets an actual Type.
actualValue() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.InvalidChar
Gets an actual String.
actualValue() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.InvalidNumber
Gets an actual Number value.
AlreadyDecodedError - Record Class in dev.siroshun.codec4j.api.decoder.object
A DecodeError when a field is already decoded.
AlreadyDecodedError(String) - Constructor for record class dev.siroshun.codec4j.api.decoder.object.AlreadyDecodedError
Constructs a new AlreadyDecodedError.
append(Function<Out<O>, Result<O, EncodeError>>) - Method in interface dev.siroshun.codec4j.api.io.ElementAppender
Appends an element to the output destination.
append(Function<Out<O>, Result<O, EncodeError>>, Function<Out<O>, Result<O, EncodeError>>) - Method in interface dev.siroshun.codec4j.api.io.EntryAppender
Appends a key-value pair to the output destination.
asFailure() - Method in interface dev.siroshun.codec4j.api.error.DecodeError
Converts this DecodeError to Result.Failure.
asFailure() - Method in interface dev.siroshun.codec4j.api.error.EncodeError
Converts this EncodeError to Result.Failure.
asIgnorable() - Method in interface dev.siroshun.codec4j.api.error.DecodeError
Makes this DecodeError ignorable.

B

Base64Codec - Class in dev.siroshun.codec4j.api.codec
A Codec for
invalid reference
byte[]
.
Base64Codec.InvalidBase64Error - Record Class in dev.siroshun.codec4j.api.codec
BOOLEAN - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for Boolean.
BOOLEAN - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for Boolean.
build(Function<T, F>) - Method in class dev.siroshun.codec4j.api.codec.object.FieldCodecBuilder
 
build(Function<T, F>, Predicate<T>) - Method in class dev.siroshun.codec4j.api.codec.object.FieldCodecBuilder
 
builder(String, Codec<F>) - Static method in interface dev.siroshun.codec4j.api.codec.object.FieldCodec
 
byName(Class<E>) - Static method in class dev.siroshun.codec4j.api.codec.EnumCodec
Creates a new Codec of the specified Enum class using Enum.name() for encoding/decoding.
byOrdinal(Class<E>) - Static method in class dev.siroshun.codec4j.api.codec.EnumCodec
Creates a new Codec of the specified Enum class using Enum.ordinal() for encoding/decoding.
BYTE - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for Byte.
BYTE - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for Byte.
byValueType(Type.Value<T>) - Static method in interface dev.siroshun.codec4j.api.codec.Codec
Gets the Codec of the specified Type.Value.

C

canOmit(T) - Method in interface dev.siroshun.codec4j.api.encoder.object.FieldEncoder
 
catchError(Function<? super DecodeError, Result<T, DecodeError>>) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Catches a DecodeError and returns a new Result.
cause() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.FatalError
Gets a Throwable that caused the error.
cause() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.IterationError
Gets a Result.Failure that is returned when iterating elements.
cause() - Method in interface dev.siroshun.codec4j.api.error.EncodeError.FatalError
Gets the Throwable that caused the error.
CHAR - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
CHAR - Static variable in interface dev.siroshun.codec4j.api.io.Type
codec(Encoder<? super A>, Decoder<? extends A>) - Static method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec with the specified Encoder and Decoder.
codec(Encoder<? super A>, Decoder<? extends A>, String) - Static method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec with the specified Encoder, Decoder and name.
Codec<T> - Interface in dev.siroshun.codec4j.api.codec
An interface for encoding and decoding data.
CODEC - Static variable in class dev.siroshun.codec4j.api.codec.Base64Codec
A Codec for
invalid reference
byte[]
, encoding as String using Base64.getEncoder() and decoding as
invalid reference
byte[]
using Base64.getDecoder().
collection(Codec<E>) - Static method in class dev.siroshun.codec4j.api.codec.collection.CollectionCodec
Creates a CollectionCodec for Collection with the specified element type CollectionCodec.
CollectionCodec - Class in dev.siroshun.codec4j.api.codec.collection
A Codec for collections such as List and Set.
comap(Function<? super A, ? extends T>) - Method in interface dev.siroshun.codec4j.api.encoder.Encoder
Maps the input data to another type.
create(EntryProcessor<K, V, Map.Entry<K, V>, Map<K, V>>) - Static method in class dev.siroshun.codec4j.api.codec.collection.MapCodec
Creates a MapCodec with the specified EntryProcessor.
create(Encoder<E>) - Static method in interface dev.siroshun.codec4j.api.codec.collection.ElementEncoder
Creates an ElementEncoder for encoding elements of ElementEncoder to an Out.
create(FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldDecoder<F>) - Static method in interface dev.siroshun.codec4j.api.codec.object.FieldCodec
 
create(FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>, FieldEncoder<T>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(Function10<F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>, FieldCodec<T, F4>, FieldCodec<T, F5>, FieldCodec<T, F6>, FieldCodec<T, F7>, FieldCodec<T, F8>, FieldCodec<T, F9>, FieldCodec<T, F10>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function10<F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>, FieldDecoder<F4>, FieldDecoder<F5>, FieldDecoder<F6>, FieldDecoder<F7>, FieldDecoder<F8>, FieldDecoder<F9>, FieldDecoder<F10>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function3<F1, F2, F3, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function3<F1, F2, F3, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function4<F1, F2, F3, F4, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>, FieldCodec<T, F4>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function4<F1, F2, F3, F4, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>, FieldDecoder<F4>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function5<F1, F2, F3, F4, F5, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>, FieldCodec<T, F4>, FieldCodec<T, F5>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function5<F1, F2, F3, F4, F5, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>, FieldDecoder<F4>, FieldDecoder<F5>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function6<F1, F2, F3, F4, F5, F6, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>, FieldCodec<T, F4>, FieldCodec<T, F5>, FieldCodec<T, F6>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function6<F1, F2, F3, F4, F5, F6, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>, FieldDecoder<F4>, FieldDecoder<F5>, FieldDecoder<F6>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function7<F1, F2, F3, F4, F5, F6, F7, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>, FieldCodec<T, F4>, FieldCodec<T, F5>, FieldCodec<T, F6>, FieldCodec<T, F7>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function7<F1, F2, F3, F4, F5, F6, F7, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>, FieldDecoder<F4>, FieldDecoder<F5>, FieldDecoder<F6>, FieldDecoder<F7>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function8<F1, F2, F3, F4, F5, F6, F7, F8, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>, FieldCodec<T, F4>, FieldCodec<T, F5>, FieldCodec<T, F6>, FieldCodec<T, F7>, FieldCodec<T, F8>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function8<F1, F2, F3, F4, F5, F6, F7, F8, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>, FieldDecoder<F4>, FieldDecoder<F5>, FieldDecoder<F6>, FieldDecoder<F7>, FieldDecoder<F8>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function9<F1, F2, F3, F4, F5, F6, F7, F8, F9, T>, FieldCodec<T, F1>, FieldCodec<T, F2>, FieldCodec<T, F3>, FieldCodec<T, F4>, FieldCodec<T, F5>, FieldCodec<T, F6>, FieldCodec<T, F7>, FieldCodec<T, F8>, FieldCodec<T, F9>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function9<F1, F2, F3, F4, F5, F6, F7, F8, F9, T>, FieldDecoder<F1>, FieldDecoder<F2>, FieldDecoder<F3>, FieldDecoder<F4>, FieldDecoder<F5>, FieldDecoder<F6>, FieldDecoder<F7>, FieldDecoder<F8>, FieldDecoder<F9>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(String, Decoder<F>, Supplier<Result<F, DecodeError>>) - Static method in interface dev.siroshun.codec4j.api.decoder.object.FieldDecoder
 
create(String, Encoder<F>, Function<T, F>, Predicate<T>) - Static method in interface dev.siroshun.codec4j.api.encoder.object.FieldEncoder
 
create(Collection<FieldEncoder<T>>) - Static method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
create(BiFunction<F1, F2, T>, FieldCodec<T, F1>, FieldCodec<T, F2>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(BiFunction<F1, F2, T>, FieldDecoder<F1>, FieldDecoder<F2>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
create(Function<F1, T>, FieldCodec<T, F1>) - Static method in class dev.siroshun.codec4j.api.codec.object.ObjectCodec
 
create(Function<F1, T>, FieldDecoder<F1>) - Static method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
createIdentity() - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder.DecodeProcessor
createIdentity() - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
createList() - Method in interface dev.siroshun.codec4j.api.io.Out
Creates a new list in the output destination.
createMap() - Method in interface dev.siroshun.codec4j.api.io.Out
Creates a new map in the output destination.
createParentDirectory(Path) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 

D

decode(In) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryDecoder
 
decode(In) - Method in class dev.siroshun.codec4j.api.codec.collection.MapCodec
 
decode(In) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Decodes the data from the provided In.
decode(In) - Method in class dev.siroshun.codec4j.api.decoder.object.ObjectDecoder
 
decode(In) - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder
 
decodeElement(In) - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder.DecodeProcessor
Decodes an element from the provided In.
DecodeError - Interface in dev.siroshun.codec4j.api.error
An interface to indicate errors when decoding.
DecodeError.Failure - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a DecodeError for custom error type.
DecodeError.FatalError - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a DecodeError when fatal error occurred while decoding.
DecodeError.IgnorableError - Interface in dev.siroshun.codec4j.api.error
An interface that marks a DecodeError as ignorable.
DecodeError.InvalidChar - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a DecodeError when the data is invalid Character.
DecodeError.InvalidNumber - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a DecodeError when the data is invalid number.
DecodeError.InvalidNumberFormat - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a DecodeError when the data is an invalid number format.
DecodeError.IterationError - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a DecodeError when Result.Failure is returned when iterating elements.
DecodeError.TypeMismatch - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a DecodeError when the type is different from the expected type.
decodeFieldValue(In) - Method in interface dev.siroshun.codec4j.api.decoder.object.FieldDecoder
 
decodeFrom(InputStream, Decoder<? extends T>) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
decodeFrom(Reader, Decoder<? extends T>) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
decodeFrom(Path, Decoder<? extends T>) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
decodeKey(In) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
Decodes a key from the provided input source.
decodeProcessor() - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder
Returns the ElementDecoder.DecodeProcessor for decoding elements and collect them.
Decoder<T> - Interface in dev.siroshun.codec4j.api.decoder
An interface for decoding data from an In.
decodeString(Decoder<? extends T>, String) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
decodeValue(In) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
Decodes a value from the provided input source.
DefaultOpenOptions - Class in dev.siroshun.codec4j.api.file
 
defaultValue(F) - Method in class dev.siroshun.codec4j.api.codec.object.FieldCodecBuilder
 
defaultValueSupplier(Supplier<F>) - Method in class dev.siroshun.codec4j.api.codec.object.FieldCodecBuilder
 
dev.siroshun.codec4j.api.codec - package dev.siroshun.codec4j.api.codec
 
dev.siroshun.codec4j.api.codec.collection - package dev.siroshun.codec4j.api.codec.collection
 
dev.siroshun.codec4j.api.codec.object - package dev.siroshun.codec4j.api.codec.object
A package for creating Codecs for custom objects.
dev.siroshun.codec4j.api.decoder - package dev.siroshun.codec4j.api.decoder
 
dev.siroshun.codec4j.api.decoder.object - package dev.siroshun.codec4j.api.decoder.object
 
dev.siroshun.codec4j.api.encoder - package dev.siroshun.codec4j.api.encoder
 
dev.siroshun.codec4j.api.encoder.object - package dev.siroshun.codec4j.api.encoder.object
A package for creating Encoders for custom objects.
dev.siroshun.codec4j.api.error - package dev.siroshun.codec4j.api.error
 
dev.siroshun.codec4j.api.file - package dev.siroshun.codec4j.api.file
 
dev.siroshun.codec4j.api.io - package dev.siroshun.codec4j.api.io
 
DOUBLE - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for Double.
DOUBLE - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for Double.
DuplicatedElementError - Record Class in dev.siroshun.codec4j.api.codec.collection
A DecodeError when an element is duplicated during decoding into a collection that does not allow duplicates.
DuplicatedElementError(Object) - Constructor for record class dev.siroshun.codec4j.api.codec.collection.DuplicatedElementError
Creates an instance of a DuplicatedElementError record class.
DuplicatedKeyError(Object, Object) - Constructor for record class dev.siroshun.codec4j.api.codec.collection.MapCodec.DuplicatedKeyError
Creates an instance of a DuplicatedKeyError record class.

E

element() - Method in record class dev.siroshun.codec4j.api.codec.collection.DuplicatedElementError
Returns the value of the element record component.
ElementAppender<O> - Interface in dev.siroshun.codec4j.api.io
An interface for writing elements to an Out.
ElementDecoder<E,R> - Interface in dev.siroshun.codec4j.api.codec.collection
ElementDecoder.DecodeProcessor<E,C> - Interface in dev.siroshun.codec4j.api.codec.collection
An interface to processing elements of the collection.
ElementEncoder<E,T> - Interface in dev.siroshun.codec4j.api.codec.collection
An Encoder for encoding elements to an Out.
ElementEncoder.EncodeProcessor<E,C> - Interface in dev.siroshun.codec4j.api.codec.collection
An interface for processing elements of the collection.
encode(Out<O>, T) - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementEncoder
 
encode(Out<O>, T) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryEncoder
 
encode(Out<O>, T) - Method in interface dev.siroshun.codec4j.api.encoder.Encoder
Encodes the data from the provided Encoder to the provided Out.
encode(Out<O>, T) - Method in class dev.siroshun.codec4j.api.encoder.object.ObjectEncoder
 
encode(Out<O>, Map<K, V>) - Method in class dev.siroshun.codec4j.api.codec.collection.MapCodec
 
encodeElement(Out<O>, E) - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementEncoder.EncodeProcessor
Encodes an element to the provided Out.
EncodeError - Interface in dev.siroshun.codec4j.api.error
An interface to indicate errors when encoding.
EncodeError.Failure - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a EncodeError for custom error type.
EncodeError.FatalError - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a EncodeError when a fatal error occurred while encoding.
EncodeError.NotWritableType - Interface in dev.siroshun.codec4j.api.error
An interface that indicates a EncodeError when the type is not writable.
encodeFieldValue(Out<O>, T) - Method in interface dev.siroshun.codec4j.api.encoder.object.FieldEncoder
 
encodeKey(Out<O>, E) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
Encodes the key of the entry to the provided Out.
encodeProcessor() - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementEncoder
Returns the ElementEncoder.EncodeProcessor for extracting elements from ElementEncoder and decoding them.
Encoder<T> - Interface in dev.siroshun.codec4j.api.encoder
An interface for encoding data to an Out.
encodeTo(OutputStream, Encoder<? super T>, T) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
encodeTo(Writer, Encoder<? super T>, T) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
encodeTo(Path, Encoder<? super T>, T) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
encodeToString(Encoder<? super T>, T) - Method in interface dev.siroshun.codec4j.api.file.TextFileIO
 
encodeValue(Out<O>, E) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
Encodes the value of the given entry to the provided Out.
EntryAppender<O> - Interface in dev.siroshun.codec4j.api.io
An interface for writing key-value to an Out.
EntryDecoder<K,V,R> - Interface in dev.siroshun.codec4j.api.codec.collection
EntryEncoder<E,T> - Interface in dev.siroshun.codec4j.api.codec.collection
An Encoder for encoding entries to an Out.
EntryIn - Interface in dev.siroshun.codec4j.api.io
An interface for reading key-value from an In.
EntryProcessor<K,V,E,T> - Interface in dev.siroshun.codec4j.api.codec.collection
An interface to processing entries of the collection.
enumClass() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumNameDecodeError
Returns the value of the enumClass record component.
enumClass() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumOrdinalDecodeError
Returns the value of the enumClass record component.
EnumCodec - Class in dev.siroshun.codec4j.api.codec
A Codec for Enums.
EnumCodec.UnknownEnumNameDecodeError - Record Class in dev.siroshun.codec4j.api.codec
EnumCodec.UnknownEnumOrdinalDecodeError - Record Class in dev.siroshun.codec4j.api.codec
equals(Object) - Method in record class dev.siroshun.codec4j.api.codec.Base64Codec.InvalidBase64Error
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.siroshun.codec4j.api.codec.collection.DuplicatedElementError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.siroshun.codec4j.api.codec.collection.MapCodec.DuplicatedKeyError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumNameDecodeError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumOrdinalDecodeError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.siroshun.codec4j.api.codec.UUIDCodec.InvalidUUIDFormatError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.siroshun.codec4j.api.decoder.object.AlreadyDecodedError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.siroshun.codec4j.api.decoder.object.RequiredFieldError
Indicates whether some other object is "equal to" this one.
error() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.IgnorableError
Gets an original DecodeError.
exception() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.InvalidNumberFormat
Gets a caused NumberFormatException.
expectedType() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.InvalidNumber
Gets an expected Type.NumberValue.
expectedType() - Method in interface dev.siroshun.codec4j.api.error.DecodeError.TypeMismatch
Gets an expected Type.

F

fatalError(Throwable) - Static method in interface dev.siroshun.codec4j.api.error.DecodeError
Creates a DecodeError when fatal error occurred while decoding.
fatalError(Throwable) - Static method in interface dev.siroshun.codec4j.api.error.EncodeError
Creates a EncodeError when a fatal error occurred while encoding.
FieldCodec<T,F> - Interface in dev.siroshun.codec4j.api.codec.object
 
FieldCodecBuilder<F> - Class in dev.siroshun.codec4j.api.codec.object
 
FieldDecoder<F> - Interface in dev.siroshun.codec4j.api.decoder.object
 
FieldEncoder<T> - Interface in dev.siroshun.codec4j.api.encoder.object
 
fieldName() - Method in record class dev.siroshun.codec4j.api.decoder.object.AlreadyDecodedError
Returns the value of the fieldName record component.
fieldName() - Method in interface dev.siroshun.codec4j.api.decoder.object.FieldDecoder
 
fieldName() - Method in record class dev.siroshun.codec4j.api.decoder.object.RequiredFieldError
Returns the value of the fieldName record component.
fieldName() - Method in interface dev.siroshun.codec4j.api.encoder.object.FieldEncoder
 
fileOpenOptions() - Static method in class dev.siroshun.codec4j.api.file.DefaultOpenOptions
 
finalizeIdentity(C) - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder.DecodeProcessor
Finalizes the identity object of ElementDecoder.DecodeProcessor.
finalizeIdentity(T) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
Finalizes the identity object of EntryProcessor.
finish() - Method in interface dev.siroshun.codec4j.api.io.ElementAppender
Finishes writing elements to the output destination.
finish() - Method in interface dev.siroshun.codec4j.api.io.EntryAppender
Finishes writing key-value pairs to the output destination.
flatComap(Function<? super A, ? extends Result<? extends T, EncodeError>>) - Method in interface dev.siroshun.codec4j.api.encoder.Encoder
Maps the input data to another type and flattens the Result.
flatMap(Function<? super T, Result<A, DecodeError>>) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Maps the decoded data to another type and flattens the Result.
flatXmap(Function<? super A, Result<T, EncodeError>>, Function<? super T, Result<A, DecodeError>>) - Method in interface dev.siroshun.codec4j.api.codec.Codec
Maps the data from the provided Codec to another type and flattens the Result.
FLOAT - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for Float.
FLOAT - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for Float.

H

hashCode() - Method in record class dev.siroshun.codec4j.api.codec.Base64Codec.InvalidBase64Error
Returns a hash code value for this object.
hashCode() - Method in record class dev.siroshun.codec4j.api.codec.collection.DuplicatedElementError
Returns a hash code value for this object.
hashCode() - Method in record class dev.siroshun.codec4j.api.codec.collection.MapCodec.DuplicatedKeyError
Returns a hash code value for this object.
hashCode() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumNameDecodeError
Returns a hash code value for this object.
hashCode() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumOrdinalDecodeError
Returns a hash code value for this object.
hashCode() - Method in record class dev.siroshun.codec4j.api.codec.UUIDCodec.InvalidUUIDFormatError
Returns a hash code value for this object.
hashCode() - Method in record class dev.siroshun.codec4j.api.decoder.object.AlreadyDecodedError
Returns a hash code value for this object.
hashCode() - Method in record class dev.siroshun.codec4j.api.decoder.object.RequiredFieldError
Returns a hash code value for this object.

I

In - Interface in dev.siroshun.codec4j.api.io
An interface for reading and decoding data from various sources.
input() - Method in record class dev.siroshun.codec4j.api.codec.Base64Codec.InvalidBase64Error
Returns the value of the input record component.
input() - Method in record class dev.siroshun.codec4j.api.codec.UUIDCodec.InvalidUUIDFormatError
Returns the value of the input record component.
inspect(Function<? super T, Result<T, DecodeError>>) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Inspects the decoded data.
INT - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for Integer.
INT - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for Integer.
InvalidBase64Error(String) - Constructor for record class dev.siroshun.codec4j.api.codec.Base64Codec.InvalidBase64Error
Creates an instance of a InvalidBase64Error record class.
invalidChar(String) - Static method in interface dev.siroshun.codec4j.api.error.DecodeError
Creates a DecodeError when the data is invalid Character.
invalidNumber(Type.NumberValue<?>, Number) - Static method in interface dev.siroshun.codec4j.api.error.DecodeError
Creates a DecodeError when the data is invalid number.
invalidNumberFormat(NumberFormatException) - Static method in interface dev.siroshun.codec4j.api.error.DecodeError
Creates a DecodeError when the data is an invalid number format.
InvalidUUIDFormatError(String) - Constructor for record class dev.siroshun.codec4j.api.codec.UUIDCodec.InvalidUUIDFormatError
Creates an instance of a InvalidUUIDFormatError record class.
isBoolean() - Method in interface dev.siroshun.codec4j.api.io.Type
Whether this Type is a Type.BooleanValue type.
isIgnorable() - Method in interface dev.siroshun.codec4j.api.error.DecodeError
Returns whether this DecodeError can be ignored.
isList() - Method in interface dev.siroshun.codec4j.api.io.Type
Whether this Type is a Type.ListType type.
isMap() - Method in interface dev.siroshun.codec4j.api.io.Type
Whether this Type is a Type.MapType type.
isNumber() - Method in interface dev.siroshun.codec4j.api.io.Type
Whether this Type is a Type.NumberValue type.
isString() - Method in interface dev.siroshun.codec4j.api.io.Type
Whether this Type is a Type.StringValue type.
isUnknown() - Method in interface dev.siroshun.codec4j.api.io.Type
Whether this Type is an Type.Unknown type.
iterationError(Result.Failure<?, ?>) - Static method in interface dev.siroshun.codec4j.api.error.DecodeError
Creates a DecodeError when Result.Failure is returned when iterating elements.

K

key() - Method in record class dev.siroshun.codec4j.api.codec.collection.MapCodec.DuplicatedKeyError
Returns the value of the key record component.
keyIn() - Method in interface dev.siroshun.codec4j.api.io.EntryIn
Gets the In for reading the key.
knownTypes() - Static method in interface dev.siroshun.codec4j.api.io.Type
Gets a List of all known Types.

L

list(Codec<E>) - Static method in class dev.siroshun.codec4j.api.codec.collection.CollectionCodec
Creates a Codec for List with the specified element type CollectionCodec.
list(Decoder<E>) - Static method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder
Creates a ElementDecoder for decoding elements as a List.
LIST - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for a list.
LONG - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for Long.
LONG - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for Long.

M

map(Codec<K>, Codec<V>) - Static method in class dev.siroshun.codec4j.api.codec.collection.MapCodec
Creates a MapCodec with the specified key and value Codec.
map(Codec<K>, Codec<V>, Supplier<Map<K, V>>, boolean, UnaryOperator<Map<K, V>>) - Static method in class dev.siroshun.codec4j.api.codec.collection.MapCodec
Creates a MapCodec with the specified key and value Codec, the custom Map factory, and other options.
map(Function<? super T, ? extends A>) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Maps the decoded data to another type.
MAP - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for a map.
MapCodec<K,V> - Class in dev.siroshun.codec4j.api.codec.collection
A Codec for Map.
MapCodec.DuplicatedKeyError - Record Class in dev.siroshun.codec4j.api.codec.collection
A DecodeError when an entry is duplicated during decoding into a map that does not allow duplicates.

N

name() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumNameDecodeError
Returns the value of the name record component.
named(String) - Method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec with the specified name and this Codec as the delegate codec.
notWritableType(Type) - Static method in interface dev.siroshun.codec4j.api.error.EncodeError
Creates a EncodeError when the type is not writable.
numberTypes() - Static method in interface dev.siroshun.codec4j.api.io.Type
Gets a List of all Type.NumberValues.

O

ObjectCodec - Class in dev.siroshun.codec4j.api.codec.object
 
ObjectDecoder<T> - Class in dev.siroshun.codec4j.api.decoder.object
 
ObjectEncoder<T> - Class in dev.siroshun.codec4j.api.encoder.object
 
onNotDecoded() - Method in interface dev.siroshun.codec4j.api.decoder.object.FieldDecoder
 
optional(String, Decoder<F>, F) - Static method in interface dev.siroshun.codec4j.api.decoder.object.FieldDecoder
 
ordinal() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumOrdinalDecodeError
Returns the value of the ordinal record component.
Out<O> - Interface in dev.siroshun.codec4j.api.io
An interface for writing and encoding data to various destinations.

P

processor() - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryDecoder
Returns the EntryProcessor for decoding entries and collect them.
processor() - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryEncoder
Returns the EntryProcessor for extracting entries from EntryEncoder and decoding them.

R

readAsBoolean() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a Boolean.
readAsByte() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a Byte.
readAsChar() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a Character.
readAsDouble() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a Double.
readAsFloat() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a Float.
readAsInt() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as an Integer.
readAsLong() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a Long.
readAsShort() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a Short.
readAsString() - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a String.
readList(R, BiFunction<R, ? super In, Result<?, ?>>) - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a list, using the provided identity object and operator.
readMap(R, BiFunction<R, ? super EntryIn, Result<?, ?>>) - Method in interface dev.siroshun.codec4j.api.io.In
Reads the current value as a map, using the provided identity object and operator.
required(String, Decoder<F>) - Static method in interface dev.siroshun.codec4j.api.decoder.object.FieldDecoder
 
RequiredFieldError - Record Class in dev.siroshun.codec4j.api.decoder.object
A DecodeError when a required field is not decoded.
RequiredFieldError(String) - Constructor for record class dev.siroshun.codec4j.api.decoder.object.RequiredFieldError
Constructs a new RequiredFieldError.

S

set(Codec<E>) - Static method in class dev.siroshun.codec4j.api.codec.collection.CollectionCodec
Creates a Codec for Set with the specified element type CollectionCodec.
set(Codec<E>, boolean) - Static method in class dev.siroshun.codec4j.api.codec.collection.CollectionCodec
Creates a Codec for Set with the specified element type CollectionCodec.
set(Decoder<E>) - Static method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder
Creates a ElementDecoder for decoding elements as a Set.
set(Decoder<E>, boolean) - Static method in interface dev.siroshun.codec4j.api.codec.collection.ElementDecoder
Creates a ElementDecoder for decoding elements as a Set.
SHORT - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for Short.
SHORT - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for Short.
STRING - Static variable in interface dev.siroshun.codec4j.api.codec.Codec
A Codec for String.
STRING - Static variable in interface dev.siroshun.codec4j.api.io.Type
A Type for String.
supplying(String, Decoder<F>, Supplier<F>) - Static method in interface dev.siroshun.codec4j.api.decoder.object.FieldDecoder
 

T

TextFileIO - Interface in dev.siroshun.codec4j.api.file
 
toCollectionCodec() - Method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec for Collection of Codec.
toCollectionEncoder() - Method in interface dev.siroshun.codec4j.api.encoder.Encoder
Creates a new ElementEncoder that encodes the collection of Encoder to an Out.
toEntryIterator(T) - Method in interface dev.siroshun.codec4j.api.codec.collection.EntryProcessor
Creates an Iterator from EntryProcessor for encoding entries.
toFieldCodec(String) - Method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new FieldCodecBuilder for Codec.
toFieldEncoder(String, Function<O, T>) - Method in interface dev.siroshun.codec4j.api.encoder.Encoder
 
toFieldEncoder(String, Function<O, T>, Predicate<O>) - Method in interface dev.siroshun.codec4j.api.encoder.Encoder
 
toIterator(C) - Method in interface dev.siroshun.codec4j.api.codec.collection.ElementEncoder.EncodeProcessor
Creates an Iterator from ElementEncoder.EncodeProcessor for encoding elements.
toListCodec() - Method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec for List of Codec.
toListDecoder() - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Creates a Decoder that decodes a List of Decoder.
toMapCodecAsKey(Codec<V>) - Method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec for Map of Codec as a key.
toMapCodecAsValue(Codec<K>) - Method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec for Map of Codec as a value.
toOptionalFieldDecoder(String, T) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
 
toRequiredFieldDecoder(String) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
 
toSetCodec() - Method in interface dev.siroshun.codec4j.api.codec.Codec
Creates a new Codec for Set of Codec.
toSetDecoder() - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Creates a Decoder that decodes a Set of Decoder.
toSetDecoder(boolean) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
Creates a Decoder that decodes a Set of Decoder.
toString() - Method in record class dev.siroshun.codec4j.api.codec.Base64Codec.InvalidBase64Error
Returns a string representation of this record class.
toString() - Method in record class dev.siroshun.codec4j.api.codec.collection.DuplicatedElementError
Returns a string representation of this record class.
toString() - Method in record class dev.siroshun.codec4j.api.codec.collection.MapCodec.DuplicatedKeyError
Returns a string representation of this record class.
toString() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumNameDecodeError
Returns a string representation of this record class.
toString() - Method in record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumOrdinalDecodeError
Returns a string representation of this record class.
toString() - Method in record class dev.siroshun.codec4j.api.codec.UUIDCodec.InvalidUUIDFormatError
Returns a string representation of this record class.
toString() - Method in record class dev.siroshun.codec4j.api.decoder.object.AlreadyDecodedError
Returns a string representation of this record class.
toString() - Method in record class dev.siroshun.codec4j.api.decoder.object.RequiredFieldError
Returns a string representation of this record class.
toSupplyingFieldDecoder(String, Supplier<T>) - Method in interface dev.siroshun.codec4j.api.decoder.Decoder
 
type() - Method in interface dev.siroshun.codec4j.api.error.EncodeError.NotWritableType
Gets the Type that is not writable.
type() - Method in interface dev.siroshun.codec4j.api.io.In
Returns the type of the current value.
Type - Interface in dev.siroshun.codec4j.api.io
An interface providing basic types that are supported by Codec4J.
Type.BooleanValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Boolean.
Type.ByteValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Byte.
Type.CharValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Character.
Type.DoubleValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Double.
Type.FloatValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Float.
Type.IntValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Integer.
Type.ListType - Class in dev.siroshun.codec4j.api.io
A Type for a list.
Type.LongValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Long.
Type.MapType - Class in dev.siroshun.codec4j.api.io
A Type for a map.
Type.NumberValue<T> - Interface in dev.siroshun.codec4j.api.io
A Type.Value type for Numbers.
Type.ShortValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for Short.
Type.StringValue - Class in dev.siroshun.codec4j.api.io
A Type.Value type for String.
Type.Unknown - Class in dev.siroshun.codec4j.api.io
A Type for an unknown type.
Type.Value<T> - Interface in dev.siroshun.codec4j.api.io
An interface indicating that Type is Type.Value.
typeMismatch(Type, Type) - Static method in interface dev.siroshun.codec4j.api.error.DecodeError
Creates a DecodeError when the type is different from the expected type.
types() - Static method in interface dev.siroshun.codec4j.api.io.Type
Gets a List of all Types.

U

UNKNOWN - Static variable in interface dev.siroshun.codec4j.api.io.Type
An unknown Type.
UnknownEnumNameDecodeError(Class<?>, String) - Constructor for record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumNameDecodeError
Creates an instance of a UnknownEnumNameDecodeError record class.
UnknownEnumOrdinalDecodeError(Class<?>, int) - Constructor for record class dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumOrdinalDecodeError
Creates an instance of a UnknownEnumOrdinalDecodeError record class.
UUID_AS_STRING - Static variable in class dev.siroshun.codec4j.api.codec.UUIDCodec
A Codec for UUID.
UUIDCodec - Class in dev.siroshun.codec4j.api.codec
A Codec for UUID.
UUIDCodec.InvalidUUIDFormatError - Record Class in dev.siroshun.codec4j.api.codec

V

value() - Method in record class dev.siroshun.codec4j.api.codec.collection.MapCodec.DuplicatedKeyError
Returns the value of the value record component.
valueIn() - Method in interface dev.siroshun.codec4j.api.io.EntryIn
Gets the In for reading the value.
valueTypes() - Static method in interface dev.siroshun.codec4j.api.io.Type
Gets a List of all Type.Values.

W

writeBoolean(boolean) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a Boolean value to the output destination.
writeByte(byte) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a Byte value to the output destination.
writeChar(char) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a Character value to the output destination.
writeDouble(double) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a Double value to the output destination.
writeFloat(float) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a Float value to the output destination.
writeInt(int) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes an Integer value to the output destination.
writeLong(long) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a Long value to the output destination.
writeShort(short) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a Short value to the output destination.
writeString(String) - Method in interface dev.siroshun.codec4j.api.io.Out
Writes a String value to the output destination.

X

xmap(Function<? super A, ? extends T>, Function<? super T, ? extends A>) - Method in interface dev.siroshun.codec4j.api.codec.Codec
Maps the data from the provided Codec to another type.
A B C D E F H I K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages