ValueLine (ConfigPlus Plugin 1.2.0 API)

java.lang.Object
- nl.taico.configplus.Line
- - nl.taico.configplus.ValueLine

All Implemented Interfaces:

IBasicValue

Direct Known Subclasses:

BukkitValueLine
```
public class ValueLine
extends Line
implements IBasicValue
```
Represents a single YAML value.

Author:

Taico

Field Summary

Fields
Modifier and Type Field and Description

protected Object cached

protected String value
- Fields inherited from class nl.taico.configplus.Line
  path

Fields
Modifier and Type	Field and Description
`protected Object`	`cached`
`protected String`	`value`

Constructor Summary

Constructors
Constructor and Description

ValueLine(String path, String value)

Constructors
Constructor and Description
`ValueLine(String path, String value)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`getBoolean()` Gets the value of this line as a boolean. If this line is not a boolean, this will return false.
`boolean`	`getBoolean(boolean def)` Gets the value of this line as a boolean. If this line is not a boolean, this will return def.
`byte`	`getByte()` Gets the value of this line as a byte. If this line is not a byte, this will return 0.
`byte`	`getByte(byte def)` Gets the value of this line as a byte. If this line is not a byte, this will return def.
`char`	`getChar()` Gets the value of this line as a char. If this line is not a char, this will return '' (null character).
`char`	`getChar(char def)` Gets the value of this line as a char. If this line is not a char, this will return def.
`protected IConverter`	`getConverter()`
`double`	`getDouble()` Gets the value of this line as a double. If this line is not a double, this will return 0.
`double`	`getDouble(double def)` Gets the value of this line as a double. If this line is not a double, this will return def.
`float`	`getFloat()` Gets the value of this line as a float. If this line is not a float, this will return 0.
`float`	`getFloat(float def)` Gets the value of this line as a float. If this line is not a float, this will return def.
`int`	`getInt()` Gets the value of this line as an int. If this line is not an int, this will return 0.
`int`	`getInt(int def)` Gets the value of this line as a int. If this line is not a int, this will return def.
`protected int`	`getLevel()`
`long`	`getLong()` Gets the value of this line as a long. If this line is not a long, this will return 0.
`long`	`getLong(long def)` Gets the value of this line as a long. If this line is not a long, this will return def.
`String`	`getName()` Returns the name of this line. The specific meaning differs between the different types of lines.
`Object`	`getObject()` Gets the value of this line and converts it to the most applicable type.
`short`	`getShort()` Gets the value of this line as a short. If this line is not a short, this will return 0.
`short`	`getShort(short def)` Gets the value of this line as a short. If this line is not a short, this will return def.
`String`	`getString()` Gets the value of this line as a String.
`<T> T`	`getT(Class<T> clazz)` Gets the value of this line as an instance of the given class. If this line is not an instance of the given class, this will return null.
`<T> T`	`getT(T def, Class<T> clazz)` Gets the value of this line as an instance of the given class. If this line is not an instance of the given class, this will return def.
`int`	`hashCode()`
`boolean`	`isBoolean()`
`boolean`	`isByte()`
`boolean`	`isChar()`
`boolean`	`isDouble()`
`boolean`	`isFloat()`
`boolean`	`isInt()`
`boolean`	`isLong()`
`boolean`	`isShort()`
`boolean`	`isString()`
`<T> boolean`	`isT(Class<T> clazz)`
`void`	`setValue(Object value)` Set the value of this line to the given object. If the given object is a String with colors, the colors are replaced with their color codes. If the given object is a Location, it is saved properly.
`String`	`toSave()`
`StringBuilder`	`toSave(StringBuilder b)`
`String`	`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

- Field Detail
  - value
```
protected String value
```
  - cached
```
protected Object cached
```
- Constructor Detail
  - ValueLine
```
public ValueLine(String path,
         String value)
```
    Parameters:
    path - - The path of this ValueLine
    value - - The value of this ValueLine
    
    Throws:
    
    IllegalArgumentException - If path is null, empty or ends with a dot.
- Method Detail
  - getByte
```
public final byte getByte()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a byte.
    If this line is not a byte, this will return 0.
    
    Specified by:
    
    getByte in interface IBasicValue
    
    Returns:
    Requested byte.
  - getByte
```
public final byte getByte(byte def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a byte.
    If this line is not a byte, this will return def.
    
    Specified by:
    
    getByte in interface IBasicValue
    
    Parameters:
    def - - The byte that will be returned if the value is not a byte.
    
    Returns:
    Requested byte.
  - isByte
```
public final boolean isByte()
```
    Specified by:
    
    isByte in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a byte.
  - getShort
```
public final short getShort()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a short.
    If this line is not a short, this will return 0.
    
    Specified by:
    
    getShort in interface IBasicValue
    
    Returns:
    Requested short.
  - getShort
```
public final short getShort(short def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a short.
    If this line is not a short, this will return def.
    
    Specified by:
    
    getShort in interface IBasicValue
    
    Parameters:
    def - - The short that will be returned if the value is not a short.
    
    Returns:
    Requested short.
  - isShort
```
public final boolean isShort()
```
    Specified by:
    
    isShort in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a short.
  - getInt
```
public final int getInt()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as an int.
    If this line is not an int, this will return 0.
    
    Specified by:
    
    getInt in interface IBasicValue
    
    Returns:
    Requested int.
  - getInt
```
public final int getInt(int def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a int.
    If this line is not a int, this will return def.
    
    Specified by:
    
    getInt in interface IBasicValue
    
    Parameters:
    def - - The int that will be returned if the value is not a int.
    
    Returns:
    Requested int.
  - isInt
```
public final boolean isInt()
```
    Specified by:
    
    isInt in interface IBasicValue
    
    Returns:
    If this value can be interpreted as an int.
  - getLong
```
public final long getLong()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a long.
    If this line is not a long, this will return 0.
    
    Specified by:
    
    getLong in interface IBasicValue
    
    Returns:
    Requested long.
  - getLong
```
public final long getLong(long def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a long.
    If this line is not a long, this will return def.
    
    Specified by:
    
    getLong in interface IBasicValue
    
    Parameters:
    def - - The long that will be returned if the value is not a long.
    
    Returns:
    Requested long.
  - isLong
```
public final boolean isLong()
```
    Specified by:
    
    isLong in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a long.
  - getFloat
```
public final float getFloat()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a float.
    If this line is not a float, this will return 0.
    
    Specified by:
    
    getFloat in interface IBasicValue
    
    Returns:
    Requested float.
  - getFloat
```
public final float getFloat(float def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a float.
    If this line is not a float, this will return def.
    
    Specified by:
    
    getFloat in interface IBasicValue
    
    Parameters:
    def - - The float that will be returned if the value is not a float.
    
    Returns:
    Requested float.
  - isFloat
```
public final boolean isFloat()
```
    Specified by:
    
    isFloat in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a float.
  - getDouble
```
public final double getDouble()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a double.
    If this line is not a double, this will return 0.
    
    Specified by:
    
    getDouble in interface IBasicValue
    
    Returns:
    Requested double.
  - getDouble
```
public final double getDouble(double def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a double.
    If this line is not a double, this will return def.
    
    Specified by:
    
    getDouble in interface IBasicValue
    
    Parameters:
    def - - The double that will be returned if the value is not a double.
    
    Returns:
    Requested double.
  - isDouble
```
public final boolean isDouble()
```
    Specified by:
    
    isDouble in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a double.
  - getBoolean
```
public final boolean getBoolean()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a boolean.
    If this line is not a boolean, this will return false.
    
    Specified by:
    
    getBoolean in interface IBasicValue
    
    Returns:
    Requested boolean.
  - getBoolean
```
public final boolean getBoolean(boolean def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a boolean.
    If this line is not a boolean, this will return def.
    
    Specified by:
    
    getBoolean in interface IBasicValue
    
    Parameters:
    def - - The boolean that will be returned if the value is not a boolean.
    
    Returns:
    Requested boolean.
  - isBoolean
```
public final boolean isBoolean()
```
    Specified by:
    
    isBoolean in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a boolean.
  - getChar
```
public final char getChar()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a char.
    If this line is not a char, this will return '' (null character).
    
    Specified by:
    
    getChar in interface IBasicValue
    
    Returns:
    Requested char.
  - getChar
```
public final char getChar(char def)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a char.
    If this line is not a char, this will return def.
    
    Specified by:
    
    getChar in interface IBasicValue
    
    Parameters:
    def - - The char that will be returned if the value is not a char.
    
    Returns:
    Requested char.
  - isChar
```
public final boolean isChar()
```
    Specified by:
    
    isChar in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a char.
  - getString
```
public String getString()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as a String.
    
    Specified by:
    
    getString in interface IBasicValue
    
    Returns:
    Requested String.
  - isString
```
public boolean isString()
```
    Specified by:
    
    isString in interface IBasicValue
    
    Returns:
    If this value can be interpreted as a String (Always True).
  - getObject
```
public final Object getObject()
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line and converts it to the most applicable type.
    
    Specified by:
    
    getObject in interface IBasicValue
    
    Returns:
    An Integer, a Long, a Double, a Boolean or a String.
  - getT
```
public final <T> T getT(Class<T> clazz)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as an instance of the given class.
    If this line is not an instance of the given class, this will return null.
    
    Specified by:
    
    getT in interface IBasicValue
    
    Parameters:
    clazz - - The class of the type to get.
    
    Returns:
    Requested object.
  - getT
```
public <T> T getT(T def,
         Class<T> clazz)
```
    Description copied from interface: IBasicValue
    
    Gets the value of this line as an instance of the given class.
    If this line is not an instance of the given class, this will return def.
    
    Specified by:
    
    getT in interface IBasicValue
    
    Parameters:
    def - - The object that will be returned if the value is not an instance of the given class.
    clazz - - The class of the type to get.
    
    Returns:
    Requested object.
  - isT
```
public <T> boolean isT(Class<T> clazz)
```
    Specified by:
    
    isT in interface IBasicValue
    
    Returns:
    If this value can be interpreted as an instance of the given class.
  - setValue
```
public final void setValue(Object value)
```
    Set the value of this line to the given object.
    If the given object is a String with colors, the colors are replaced with their color codes.
    If the given object is a Location, it is saved properly.
  - getConverter
```
protected IConverter getConverter()
```
  - toSave
```
public final String toSave()
```
    Specified by:
    
    toSave in class Line
  - toSave
```
public final StringBuilder toSave(StringBuilder b)
```
    Specified by:
    
    toSave in class Line
  - getLevel
```
protected int getLevel()
```
    Returns:
    The level this ValueLine should be at.
  - getName
```
public String getName()
```
    Description copied from class: Line
    Returns the name of this line.
    The specific meaning differs between the different types of lines.
    - CommentLine - null
    - EmptyLine - null
    - Other lines - The last part in that line's path sequence.
    Overrides:
    
    getName in class Line
    
    Returns:
    The last part in this line's path sequence.
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class Line
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Line
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Line

Class ValueLine

Field Summary

Fields inherited from class nl.taico.configplus.Line

Constructor Summary

Method Summary

Methods inherited from class nl.taico.configplus.Line

Methods inherited from class java.lang.Object

Field Detail

value

cached

Constructor Detail

ValueLine

Method Detail

getByte

getByte

isByte

getShort

getShort

isShort

getInt

getInt

isInt

getLong

getLong

isLong

getFloat

getFloat

isFloat

getDouble

getDouble

isDouble

getBoolean

getBoolean

isBoolean

getChar

getChar

isChar

getString

isString

getObject

getT

getT

isT

setValue

getConverter

toSave

toSave

getLevel

getName

toString

hashCode

equals