Package com.sk89q.commandbook.component.locations

Class FlatFileLocationsManager

java.lang.Object

com.sk89q.commandbook.component.locations.FlatFileLocationsManager

All Implemented Interfaces:

LocationManager<NamedLocation>

public class FlatFileLocationsManager
extends java.lang.Object
implements LocationManager<NamedLocation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlatFileLocationsManager.LocationsFactory

Constructor Summary

Constructors

Constructor	Description
FlatFileLocationsManager(java.io.File file, java.lang.String type)	Construct the manager.

Method Summary

Modifier and Type	Method	Description
void	castWorld(org.bukkit.World world)	Set this manager to be for one world only.
NamedLocation	create(java.lang.String id, org.bukkit.Location loc, org.bukkit.entity.Player player)	Create a location.
NamedLocation	get(java.lang.String id)	Get by name.
java.util.List<NamedLocation>	getLocations()	Gets all the locations that this location manager has.
void	load()	Load from file.
boolean	remove(java.lang.String id)	Removes a location.
void	save()	Save to file.
void	updateWorlds()	Updates warps from unloaded worlds.

Methods inherited from class java.lang.Object

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

Constructor Details

FlatFileLocationsManager

public FlatFileLocationsManager(java.io.File file, java.lang.String type)

Construct the manager.

Parameters:

file - The file locations are stored in

type - The name for the type of location being loaded

Method Details

castWorld

public void castWorld(org.bukkit.World world)

Description copied from interface: LocationManager

Set this manager to be for one world only.

Specified by:

castWorld in interface LocationManager<NamedLocation>

Parameters:

world - The world to use

load

public void load() throws java.io.IOException

Description copied from interface: LocationManager

Load from file.

Specified by:

load in interface LocationManager<NamedLocation>

Throws:

java.io.IOException - when an error occurs during IO

save

public void save() throws java.io.IOException

Description copied from interface: LocationManager

Save to file.

Specified by:

save in interface LocationManager<NamedLocation>

Throws:

java.io.IOException - when an error occurs during IO

updateWorlds

public void updateWorlds()

Description copied from interface: LocationManager

Updates warps from unloaded worlds.

Specified by:

updateWorlds in interface LocationManager<NamedLocation>

get

public NamedLocation get(java.lang.String id)

Description copied from interface: LocationManager

Get by name.

Specified by:

get in interface LocationManager<NamedLocation>

Parameters:

id - The name to get

Returns:

The LocationManager if registered

remove

public boolean remove(java.lang.String id)

Description copied from interface: LocationManager

Removes a location.

Specified by:

remove in interface LocationManager<NamedLocation>

Parameters:

id - The id to remove

Returns:

whether it was removed

getLocations

public java.util.List<NamedLocation> getLocations()

Description copied from interface: LocationManager

Gets all the locations that this location manager has.

Specified by:

getLocations in interface LocationManager<NamedLocation>

Returns:

This location manager's locations.

create

public NamedLocation create(java.lang.String id, org.bukkit.Location loc, org.bukkit.entity.Player player)

Description copied from interface: LocationManager

Create a location.

Specified by:

create in interface LocationManager<NamedLocation>

Parameters:

id - The name of the location

loc - The location

player - The player to own the location

Returns:

The created location