Package space.arim.dazzleconf.serialiser

Class URLValueSerialiser

java.lang.Object

space.arim.dazzleconf.serialiser.URLValueSerialiser

All Implemented Interfaces:

ValueSerialiser<URL>

public final class URLValueSerialiser
extends Object
implements ValueSerialiser<URL>

Value serialiser for URL

Author:

A248

Method Summary

Modifier and Type	Method	Description
URL	deserialise(FlexibleType flexibleType)	Deserializes a value from a flexible type representing a raw config value.
static URLValueSerialiser	getInstance()
Class<URL>	getTargetClass()	Gets the target type of deserialization
String	serialise(URL value, Decomposer decomposer)	Serializes a value to a raw config value.

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static URLValueSerialiser getInstance()

getTargetClass

public Class<URL> getTargetClass()

Description copied from interface: ValueSerialiser

Gets the target type of deserialization

Specified by:

getTargetClass in interface ValueSerialiser<URL>

Returns:

the target class type

deserialise

public URL deserialise(FlexibleType flexibleType)
                throws BadValueException

Description copied from interface: ValueSerialiser

Deserializes a value from a flexible type representing a raw config value.

The key (FlexibleType.getAssociatedKey()) is informative. It should not affect the deserialization, but should be included in thrown BadValueExceptions to inform the user which key is in question. To easily include the key in a BadValueException, use FlexibleType.badValueExceptionBuilder()

Specified by:

deserialise in interface ValueSerialiser<URL>

Parameters:

flexibleType - the flexible type

Returns:

the deserialized value, never null

Throws:

BadValueException - if the value could not be deserialized

serialise

public String serialise(URL value,
 Decomposer decomposer)

Description copied from interface: ValueSerialiser

Serializes a value to a raw config value. Should be the inverse operation of ValueSerialiser.deserialise(FlexibleType) in that if the result of this method were wrapped in a FlexibleType, it could be deserialized.

If this serializer serializes values by converting from another custom type, then the provided decomposer should be used to reserialize such custom types.

Specified by:

serialise in interface ValueSerialiser<URL>

Parameters:

value - the value

decomposer - the decomposer used to help breakdown the value

Returns:

the serialized value