Package dev.siroshun.codec4j.api.encoder.object

Class ObjectEncoder<T>

java.lang.Object

dev.siroshun.codec4j.api.encoder.object.ObjectEncoder<T>

All Implemented Interfaces:

Encoder<T>

public final class ObjectEncoder<T>
extends Object
implements Encoder<T>

Method Summary

Modifier and Type	Method	Description
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3, @NotNull FieldEncoder<T> field4)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3, @NotNull FieldEncoder<T> field4, @NotNull FieldEncoder<T> field5)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3, @NotNull FieldEncoder<T> field4, @NotNull FieldEncoder<T> field5, @NotNull FieldEncoder<T> field6)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3, @NotNull FieldEncoder<T> field4, @NotNull FieldEncoder<T> field5, @NotNull FieldEncoder<T> field6, @NotNull FieldEncoder<T> field7)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3, @NotNull FieldEncoder<T> field4, @NotNull FieldEncoder<T> field5, @NotNull FieldEncoder<T> field6, @NotNull FieldEncoder<T> field7, @NotNull FieldEncoder<T> field8)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3, @NotNull FieldEncoder<T> field4, @NotNull FieldEncoder<T> field5, @NotNull FieldEncoder<T> field6, @NotNull FieldEncoder<T> field7, @NotNull FieldEncoder<T> field8, @NotNull FieldEncoder<T> field9)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull FieldEncoder<T> field1, @NotNull FieldEncoder<T> field2, @NotNull FieldEncoder<T> field3, @NotNull FieldEncoder<T> field4, @NotNull FieldEncoder<T> field5, @NotNull FieldEncoder<T> field6, @NotNull FieldEncoder<T> field7, @NotNull FieldEncoder<T> field8, @NotNull FieldEncoder<T> field9, @NotNull FieldEncoder<T> field10)
static <T> @NotNull ObjectEncoder<T>	create(@NotNull Collection<FieldEncoder<T>> fields)
<O> @NotNull dev.siroshun.jfun.result.Result<O,EncodeError>	encode(@NotNull Out<O> out, @UnknownNullability T input)	Encodes the data from the provided Encoder to the provided Out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.siroshun.codec4j.api.encoder.Encoder

comap, flatComap, toCollectionEncoder, toFieldEncoder, toFieldEncoder

Method Details

create

@Contract("_ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1)

create

@Contract("_, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2)

create

@Contract("_, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3)

create

@Contract("_, _, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3,
 @NotNull
 @NotNull FieldEncoder<T> field4)

create

@Contract("_, _, _, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3,
 @NotNull
 @NotNull FieldEncoder<T> field4,
 @NotNull
 @NotNull FieldEncoder<T> field5)

create

@Contract("_, _, _, _, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3,
 @NotNull
 @NotNull FieldEncoder<T> field4,
 @NotNull
 @NotNull FieldEncoder<T> field5,
 @NotNull
 @NotNull FieldEncoder<T> field6)

create

@Contract("_, _, _, _, _, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3,
 @NotNull
 @NotNull FieldEncoder<T> field4,
 @NotNull
 @NotNull FieldEncoder<T> field5,
 @NotNull
 @NotNull FieldEncoder<T> field6,
 @NotNull
 @NotNull FieldEncoder<T> field7)

create

@Contract("_, _, _, _, _, _, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3,
 @NotNull
 @NotNull FieldEncoder<T> field4,
 @NotNull
 @NotNull FieldEncoder<T> field5,
 @NotNull
 @NotNull FieldEncoder<T> field6,
 @NotNull
 @NotNull FieldEncoder<T> field7,
 @NotNull
 @NotNull FieldEncoder<T> field8)

create

@Contract("_, _, _, _, _, _, _, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3,
 @NotNull
 @NotNull FieldEncoder<T> field4,
 @NotNull
 @NotNull FieldEncoder<T> field5,
 @NotNull
 @NotNull FieldEncoder<T> field6,
 @NotNull
 @NotNull FieldEncoder<T> field7,
 @NotNull
 @NotNull FieldEncoder<T> field8,
 @NotNull
 @NotNull FieldEncoder<T> field9)

create

@Contract("_, _, _, _, _, _, _, _, _, _ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull FieldEncoder<T> field1,
 @NotNull
 @NotNull FieldEncoder<T> field2,
 @NotNull
 @NotNull FieldEncoder<T> field3,
 @NotNull
 @NotNull FieldEncoder<T> field4,
 @NotNull
 @NotNull FieldEncoder<T> field5,
 @NotNull
 @NotNull FieldEncoder<T> field6,
 @NotNull
 @NotNull FieldEncoder<T> field7,
 @NotNull
 @NotNull FieldEncoder<T> field8,
 @NotNull
 @NotNull FieldEncoder<T> field9,
 @NotNull
 @NotNull FieldEncoder<T> field10)

create

@Contract("_ -> new")
@NotNull
public static <T> @NotNull ObjectEncoder<T> create(@NotNull
 @NotNull Collection<FieldEncoder<T>> fields)

encode

@NotNull
public <O>
@NotNull dev.siroshun.jfun.result.Result<O,EncodeError> encode(@NotNull
 @NotNull Out<O> out,
 @UnknownNullability T input)

Description copied from interface: Encoder

Encodes the data from the provided Encoder to the provided Out.

Specified by:

encode in interface Encoder<T>

Type Parameters:

O - the type of the output destination

Parameters:

out - the Out for writing the encoded data

input - the input data to encode

Returns:

a result containing the encoded data, or a EncodeError if the operation failed