com.codelanx.codelanxlib.serialize

Class SLocation

java.lang.Object

com.codelanx.codelanxlib.serialize.SLocation

All Implemented Interfaces:

ConfigurationSerializable

public class SLocation
extends Object
implements ConfigurationSerializable

Represents a ConfigurationSerializable Location with a lazily initialized world

Since:

0.0.1

Version:

0.0.1

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
SLocation(Location loc) Creates a new SLocation object from the passed Location
SLocation(Map<String,Object> config) ConfigurationSerializable constructor.
SLocation(Vector loc, UUID worldUUID, float pitch, float yaw) Allows constructing an SLocation from serialized parts

Method Summary

Modifier and Type	Method and Description
static SLocation	deserialize(Map<String,Object> config) Creates a new SLocation object and returns it.
Vector	getVector() Returns the relevant Vector object to this instance
World	getWorld() Retrieves the World object relevant to this instance.
Map<String,Object>	serialize()
Location	toLocation() Converts this instance into a Location object.
static SLocation	valueOf(Map<String,Object> config) Creates a new SLocation object and returns it.

Methods inherited from class java.lang.Object

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

Constructor Detail

SLocation

public SLocation(Location loc)

Creates a new SLocation object from the passed Location

Parameters:

loc - The Location to serialize

Since:

0.0.1

SLocation

public SLocation(Vector loc,
                 UUID worldUUID,
                 float pitch,
                 float yaw)

Allows constructing an SLocation from serialized parts

Parameters:

loc - The relevant Vector

worldUUID - The UUID of the world for this SLocation

pitch - The pitch

yaw - The yaw

Since:

0.1.0

SLocation

public SLocation(Map<String,Object> config)

ConfigurationSerializable constructor. Should not be used by anything other than Bukkit.

Parameters:

config - A serialized Map of this object

Since:

0.0.1

Method Detail

serialize

public Map<String,Object> serialize()

Specified by:

serialize in interface ConfigurationSerializable

Returns:

Since:

0.0.1

valueOf

public static SLocation valueOf(Map<String,Object> config)

Creates a new SLocation object and returns it. Should only be used by Bukkit

Parameters:

config - A serialized Map of this object

Returns:

A new SLocation object

Since:

0.0.1

deserialize

public static SLocation deserialize(Map<String,Object> config)

Creates a new SLocation object and returns it. Should only be used by Bukkit

Parameters:

config - A serialized Map of this object

Returns:

A new SLocation object

Since:

0.0.1

getWorld

public World getWorld()

Retrieves the World object relevant to this instance. This is lazily-initialized, so until this method is called the class will not attempt to retrieve the World value

Returns:

The relevant World object, or null if not found

Since:

0.0.1

getVector

public Vector getVector()

Returns the relevant Vector object to this instance

Returns:

The relevant Vector object

Since:

0.0.1

toLocation

public Location toLocation()

Converts this instance into a Location object. This method will fail if called before Bukkit has loaded any worlds

Returns:

This instance in the context of a Location object

Since:

0.0.1