nl.taico.configplus.bukkit

Class BukkitValueLine

java.lang.Object

nl.taico.configplus.Line

nl.taico.configplus.ValueLine

nl.taico.configplus.bukkit.BukkitValueLine

All Implemented Interfaces:

IBukkitValue, IBasicValue

public class BukkitValueLine
extends ValueLine
implements IBukkitValue

Represents a single YAML value.

Author:

Taico

Field Summary

Fields inherited from class nl.taico.configplus.ValueLine

cached, value

Fields inherited from class nl.taico.configplus.Line

path

Constructor Summary

Constructors

Constructor and Description
BukkitValueLine(String path, String value)

Method Summary

Methods

Modifier and Type	Method and Description
org.bukkit.Color	getColor()
org.bukkit.Color	getColor(org.bukkit.Color def)
String	getColoredString() Gets the value of this line as a String, and converts colors (&2 --> Green).
IConverter	getConverter()
org.bukkit.Location	getLocation() Gets the value of this line as a Location. If this line is not a Location, this will return null.
org.bukkit.Location	getLocation(org.bukkit.Location def) Gets the value of this line as a Location. If this line is not a Location, this will return def.
org.bukkit.Location	getLocation(org.bukkit.World world) Gets the value of this line as a Location. If this line is not a Location, this will return null.
org.bukkit.Location	getLocation(org.bukkit.World world, org.bukkit.Location def) Gets the value of this line as a Location. If this line is not a Location, this will return null.
boolean	isColor()
boolean	isLocation()
boolean	isLocationNoWorld()

Methods inherited from class nl.taico.configplus.ValueLine

equals, getBoolean, getBoolean, getByte, getByte, getChar, getChar, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLevel, getLong, getLong, getName, getObject, getShort, getShort, getString, getT, getT, hashCode, isBoolean, isByte, isChar, isDouble, isFloat, isInt, isLong, isShort, isString, isT, setValue, toSave, toSave, toString

Methods inherited from class nl.taico.configplus.Line

getPath

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.taico.configplus.interfaces.IBasicValue

getBoolean, getBoolean, getByte, getByte, getChar, getChar, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getObject, getShort, getShort, getString, getT, getT, isBoolean, isByte, isChar, isDouble, isFloat, isInt, isLong, isShort, isString, isT

Constructor Detail

BukkitValueLine

public BukkitValueLine(String path,
               String value)

Parameters:

path -

value -

Throws:

IllegalArgumentException - If path is null, empty or ends with a dot.

Method Detail

getColoredString

public String getColoredString()

Description copied from interface: IBukkitValue

Gets the value of this line as a String, and converts colors (&2 --> Green).

Specified by:

getColoredString in interface IBukkitValue

Returns:

Requested String with any colors in it converted.

getLocation

public org.bukkit.Location getLocation()

Description copied from interface: IBukkitValue

Gets the value of this line as a Location.
If this line is not a Location, this will return null.

Specified by:

getLocation in interface IBukkitValue

Returns:

Requested Location.

getLocation

public org.bukkit.Location getLocation(org.bukkit.Location def)

Description copied from interface: IBukkitValue

Gets the value of this line as a Location.
If this line is not a Location, this will return def.

Specified by:

getLocation in interface IBukkitValue

Parameters:

def - - The Location that will be returned if the value is not a Location.

Returns:

Requested Location.

isLocation

public boolean isLocation()

Specified by:

isLocation in interface IBukkitValue

Returns:

If this value can be interpreted as a Location.

getLocation

public org.bukkit.Location getLocation(org.bukkit.World world)

Description copied from interface: IBukkitValue

Gets the value of this line as a Location.
If this line is not a Location, this will return null.

Specified by:

getLocation in interface IBukkitValue

Returns:

Requested Location.

getLocation

public org.bukkit.Location getLocation(org.bukkit.World world,
                              org.bukkit.Location def)

Description copied from interface: IBukkitValue

Gets the value of this line as a Location.
If this line is not a Location, this will return null.

Specified by:

getLocation in interface IBukkitValue

Returns:

Requested Location.

isLocationNoWorld

public boolean isLocationNoWorld()

Specified by:

isLocationNoWorld in interface IBukkitValue

getColor

public org.bukkit.Color getColor()

Specified by:

getColor in interface IBukkitValue

getColor

public org.bukkit.Color getColor(org.bukkit.Color def)

Specified by:

getColor in interface IBukkitValue

isColor

public boolean isColor()

Specified by:

isColor in interface IBukkitValue

getConverter

public IConverter getConverter()

Overrides:

getConverter in class ValueLine