Package ch.njol.yggdrasil

Class Fields

java.lang.Object

ch.njol.yggdrasil.Fields

All Implemented Interfaces:

Iterable<Fields.FieldContext>

@NotThreadSafe
public final class Fields
extends Object
implements Iterable<Fields.FieldContext>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Fields.FieldContext	Holds a field's name and value, and throws StreamCorruptedExceptions if primitives or objects are used incorrectly.

Constructor Summary

Constructors

Constructor	Description
Fields()	Creates an empty Fields object.
Fields(Yggdrasil yggdrasil)
Fields(Class<?> type, Yggdrasil yggdrasil)	Creates a fields object and initialises it with all non-transient and non-static fields of the given class and its superclasses.
Fields(Object object)	Creates a fields object and initialises it with all non-transient and non-static fields of the given object.
Fields(Object object, @Nullable Yggdrasil yggdrasil)	Creates a fields object and initialises it with all non-transient and non-static fields of the given object.

Method Summary

Modifier and Type	Method	Description
boolean	contains(String fieldID)
<T> T	getAndRemoveObject(String field, Class<T> expectedType)
<T> T	getAndRemovePrimitive(String field, Class<T> expectedType)
static Collection<Field>	getFields(Class<?> type)	Gets all serializable fields of the provided class, including superclasses.
@Nullable Object	getObject(String field)
<T> T	getObject(String fieldID, Class<T> expectedType)
Object	getPrimitive(String fieldID)
<T> T	getPrimitive(String fieldID, Class<T> expectedType)
boolean	hasField(String fieldID)
Iterator<Fields.FieldContext>	iterator()
<T, R> R	mapObject(String fieldID, Class<T> type, Function<T,R> function)	Maps the object stored in the given field through the provided function.
<T, R> R	mapPrimitive(String fieldID, Class<T> type, Function<T,R> function)	Maps the primitive stored in the given field through the provided function.
void	putObject(String fieldID, @Nullable Object value)
void	putPrimitive(String fieldID, Object value)
boolean	removeField(String fieldID)	Removes a field and its value from this Fields object.
void	setFields(Object object)	Sets all fields of the given Object to the values stored in this Fields object.
void	setFields(Object object, Yggdrasil yggdrasil)	Deprecated, for removal: This API element is subject to removal in a future version.
static Fields	singletonObject(String fieldID, @Nullable Object value)	Creates a Fields object with a single object field.
static Fields	singletonPrimitive(String fieldID, Object value)	Creates a Fields object with a single primitive field.
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Fields

public Fields()

Creates an empty Fields object.

Fields

public Fields(Yggdrasil yggdrasil)

Fields

public Fields(Class<?> type,
 Yggdrasil yggdrasil)
       throws NotSerializableException

Creates a fields object and initialises it with all non-transient and non-static fields of the given class and its superclasses.

Parameters:

type - Some class

Throws:

NotSerializableException - If a field occurs more than once (i.e. if a class has a field with the same name as a field in one of its superclasses)

Fields

public Fields(Object object)
       throws NotSerializableException

Creates a fields object and initialises it with all non-transient and non-static fields of the given object.

Parameters:

object - Some object

Throws:

NotSerializableException - If a field occurs more than once (i.e. if a class has a field with the same name as a field in one of its superclasses)

Fields

public Fields(Object object,
 @Nullable
 @Nullable Yggdrasil yggdrasil)
       throws NotSerializableException

Creates a fields object and initialises it with all non-transient and non-static fields of the given object.

Parameters:

object - Some object

Throws:

NotSerializableException - If a field occurs more than once (i.e. if a class has a field with the same name as a field in one of its superclasses)

Method Details

singletonObject

public static Fields singletonObject(String fieldID,
 @Nullable
 @Nullable Object value)

Creates a Fields object with a single object field.

Parameters:

fieldID - The id of the field

value - The value of the field

Returns:

A Fields object with the given field defined

singletonPrimitive

public static Fields singletonPrimitive(String fieldID,
 Object value)

Creates a Fields object with a single primitive field.

Parameters:

fieldID - The id of the field

value - The value of the field

Returns:

A Fields object with the given field defined

mapObject

public <T,
R> R mapObject(String fieldID,
 Class<T> type,
 Function<T,R> function)
                   throws StreamCorruptedException

Maps the object stored in the given field through the provided function.

Type Parameters:

T - The type of the field

R - The return type of the mapping function

Parameters:

fieldID - The id of the field

type - The expected type of the field

function - The mapping function

Returns:

The result of applying the mapping function to the field's value

Throws:

StreamCorruptedException - If the field does not exist or is of an unexpected type

mapPrimitive

public <T,
R> R mapPrimitive(String fieldID,
 Class<T> type,
 Function<T,R> function)
                      throws StreamCorruptedException

Maps the primitive stored in the given field through the provided function.

Type Parameters:

T - The type of the field

R - The return type of the mapping function

Parameters:

fieldID - The id of the field

type - The expected type of the field

function - The mapping function

Returns:

The result of applying the mapping function to the field's value

Throws:

StreamCorruptedException - If the field does not exist or is of an unexpected type

getFields

public static Collection<Field> getFields(Class<?> type)
                                   throws NotSerializableException

Gets all serializable fields of the provided class, including superclasses.

Parameters:

type - The class to get the fields of

Returns:

All non-static and non-transient fields of the given class and its superclasses

Throws:

NotSerializableException - If a field occurs more than once (i.e. if a class has a field with the same name as a field in one of its superclasses)

setFields

public void setFields(Object object)
               throws StreamCorruptedException,
NotSerializableException

Sets all fields of the given Object to the values stored in this Fields object.

Parameters:

object - The object whose fields should be set

Throws:

YggdrasilException - If this was called on a Fields object not created by Yggdrasil itself

StreamCorruptedException

NotSerializableException

setFields

@Deprecated(since="2.3.0",
            forRemoval=true)
public void setFields(Object object,
 Yggdrasil yggdrasil)
               throws StreamCorruptedException,
NotSerializableException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

StreamCorruptedException

NotSerializableException

size

public int size()

Returns:

The number of fields defined

putObject

public void putObject(String fieldID,
 @Nullable
 @Nullable Object value)

putPrimitive

public void putPrimitive(String fieldID,
 Object value)

contains

public boolean contains(String fieldID)

Parameters:

fieldID - A field's id

Returns:

Whether the field is defined

hasField

public boolean hasField(String fieldID)

getObject

@Nullable
public @Nullable Object getObject(String field)
                           throws StreamCorruptedException

Throws:

StreamCorruptedException

getObject

@Nullable
public <T> T getObject(String fieldID,
 Class<T> expectedType)
                throws StreamCorruptedException

Throws:

StreamCorruptedException

getPrimitive

public Object getPrimitive(String fieldID)
                    throws StreamCorruptedException

Throws:

StreamCorruptedException

getPrimitive

public <T> T getPrimitive(String fieldID,
 Class<T> expectedType)
                   throws StreamCorruptedException

Throws:

StreamCorruptedException

getAndRemoveObject

@Nullable
public <T> T getAndRemoveObject(String field,
 Class<T> expectedType)
                         throws StreamCorruptedException

Throws:

StreamCorruptedException

getAndRemovePrimitive

public <T> T getAndRemovePrimitive(String field,
 Class<T> expectedType)
                            throws StreamCorruptedException

Throws:

StreamCorruptedException

removeField

public boolean removeField(String fieldID)

Removes a field and its value from this Fields object.

Parameters:

fieldID - The id of the field to remove

Returns:

Whether a field with the given name was actually defined

iterator

public Iterator<Fields.FieldContext> iterator()

Specified by:

iterator in interface Iterable<Fields.FieldContext>