Package ch.njol.skript.classes

Class YggdrasilSerializer<T extends YggdrasilSerializable>

java.lang.Object

ch.njol.yggdrasil.YggdrasilSerializer<T>

ch.njol.skript.classes.Serializer<T>

ch.njol.skript.classes.YggdrasilSerializer<T>

All Implemented Interfaces:

ClassResolver

public class YggdrasilSerializer<T extends YggdrasilSerializable>
extends Serializer<T>

Serializer that allows Yggdrasil to automatically serialize classes that extend YggdrasilSerializable.

Field Summary

Fields inherited from class ch.njol.skript.classes.Serializer

info

Constructor Summary

Constructors

Constructor	Description
YggdrasilSerializer()

Method Summary

Modifier and Type	Method	Description
boolean	canBeInstantiated()	Returns whether the class should be instantiated using its nullary constructor or not.
T	deserialize(String s)	Deprecated, for removal: This API element is subject to removal in a future version.
final void	deserialize(T o, Fields f)	Deserializes an object.
boolean	mustSyncDeserialization()	Not currently used (everything happens on Bukkit's main thread).
final Fields	serialize(T o)	Serialises the given object.

Methods inherited from class ch.njol.skript.classes.Serializer

canBeInstantiated, deserialize, deserialize, getClass, getID, newInstance

Methods inherited from class java.lang.Object

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

Constructor Details

YggdrasilSerializer

public YggdrasilSerializer()

Method Details

serialize

public final Fields serialize(T o)
                       throws NotSerializableException

Description copied from class: Serializer

Serialises the given object.

Use return new Fields(this); to emulate the default behaviour.

This method must be thread-safe. Use Task.callSync(Callable) if you need to serialise on Bukkit's main thread.

Specified by:

serialize in class Serializer<T extends YggdrasilSerializable>

Parameters:

o - The object to serialise

Returns:

A Fields object representing the object's fields to serialise. Must not be null.

Throws:

NotSerializableException - If this object could not be serialized

deserialize

public final void deserialize(T o,
 Fields f)
                       throws StreamCorruptedException,
NotSerializableException

Description copied from class: YggdrasilSerializer

Deserializes an object.

Use fields.setFields(o); to emulate the default behaviour.

Specified by:

deserialize in class Serializer<T extends YggdrasilSerializable>

Parameters:

o - The object to deserialize as returned by YggdrasilSerializer.newInstance(Class).

f - The fields read from stream

Throws:

StreamCorruptedException - If deserialization failed because the data read from stream is incomplete or invalid.

NotSerializableException

deserialize

@Deprecated(since="2.3.0",
            forRemoval=true)
public T deserialize(String s)

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

Deserialises an object from a string returned by this serializer or an earlier version thereof.

This method should only return null if the input is invalid (i.e. not produced by Serializer.serialize(Object) or an older version of that method)

This method must only be called from Bukkit's main thread if mustSyncDeserialization() returned true.

Overrides:

deserialize in class Serializer<T extends YggdrasilSerializable>

Parameters:

s -

Returns:

The deserialised object or null if the input is invalid. An error message may be logged to specify the cause.

mustSyncDeserialization

public boolean mustSyncDeserialization()

Description copied from class: Serializer

Not currently used (everything happens on Bukkit's main thread).

Specified by:

mustSyncDeserialization in class Serializer<T extends YggdrasilSerializable>

Returns:

Whether deserialisation must be done on Bukkit's main thread.

canBeInstantiated

public boolean canBeInstantiated()

Description copied from class: Serializer

Returns whether the class should be instantiated using its nullary constructor or not. Return false if the class has no nullary constructor or if you do not have control over the source of the class (e.g. if it's from an API).

You must override and use Serializer.deserialize(Fields) if this method returns false (Serializer.deserialize(Object, Fields) will no be used anymore in this case).

Specified by:

canBeInstantiated in class Serializer<T extends YggdrasilSerializable>