com.austinv11.collectiveframework.minecraft.config

Interface IConfigProxy

All Known Implementing Classes:

DefaultProxy

public interface IConfigProxy

Use this interface to create custom serializers and deserializers for configs

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSerializeObject(java.lang.Object o) Checks if the object passed can be serialized by this proxy
java.lang.Object	deserialize(java.lang.String key, java.lang.String s) Deserializes an object from a String
java.lang.String	getKey(java.lang.Object o) Returns the key representing the object
boolean	isKeyUsable(java.lang.String key) Checks if the key passed represents a config option type that can be deserialized by this
java.lang.String	serialize(java.lang.Object o) Serializes an object into a (single line) string

Method Detail

canSerializeObject

boolean canSerializeObject(java.lang.Object o)

Checks if the object passed can be serialized by this proxy

Parameters:

o - The object to check

Returns:

True if this proxy can handle the object

isKeyUsable

boolean isKeyUsable(java.lang.String key)

Checks if the key passed represents a config option type that can be deserialized by this

Parameters:

key - The key of the config type

Returns:

True if this proxy is capable of deserializing

getKey

java.lang.String getKey(java.lang.Object o)

Returns the key representing the object

Parameters:

o - The object

Returns:

The key

serialize

java.lang.String serialize(java.lang.Object o)
                           throws ConfigException

Serializes an object into a (single line) string

Parameters:

o - The object to serialize

Returns:

The serialized object

Throws:

ConfigException

deserialize

java.lang.Object deserialize(java.lang.String key,
                           java.lang.String s)
                             throws ConfigException

Deserializes an object from a String

Parameters:

key - The key representing the object type

s - The string

Returns:

The deserialized object

Throws:

ConfigException