nl.taico.configplus

Class ListLine

java.lang.Object

nl.taico.configplus.Line

nl.taico.configplus.ListLine

All Implemented Interfaces:

IBasicList

Direct Known Subclasses:

BukkitListLine

public class ListLine
extends Line
implements IBasicList

Represents a YAML List.

Author:

Taico

Field Summary

Fields

Modifier and Type	Field and Description
protected List<?>	cached
protected Class<?>	cacheType
protected List<CharSequence>	entries

Fields inherited from class nl.taico.configplus.Line

path

Constructor Summary

Constructors

Constructor and Description
ListLine(String path, boolean shortlist)

Method Summary

Methods

Modifier and Type	Method and Description
ListLine	addEntries(Iterable<?> entries)
ListLine	addEntries(String entries)
void	addEntry(CharSequence entry)
void	clear(boolean removeComments)
boolean	equals(Object obj)
List<Boolean>	getBooleanList() Gets the value of this line as a List of Booleans. Will convert all applicable values into Booleans.
List<Byte>	getByteList() Gets the value of this line as a List of Bytes. Will convert all applicable values into Bytes.
List<Character>	getCharacterList() Gets the value of this line as a List of Characters. Will convert all applicable values into Characters.
List<Comment>	getComments() Returns a list with all the comments that are inside of this ListLine.
protected IConverter	getConverter()
List<Double>	getDoubleList() Gets the value of this line as a List of Doubles. Will convert all applicable values into Doubles.
List<Float>	getFloatList() Gets the value of this line as a List of Floats. Will convert all applicable values into Floats.
List<Integer>	getIntegerList() Gets the value of this line as a List of Integers. Will convert all applicable values into Integers.
List<Long>	getLongList() Gets the value of this line as a List of Longs. Will convert all applicable values into Longs.
List<Object>	getMixedList() Converts whole numbers into Integers or Longs (whichever fits best) Converts floating point numbers into Doubles Converts true, false, yes and no into their respective Boolean values
String	getName() Returns the name of this line. The specific meaning differs between the different types of lines.
List<Short>	getShortList() Gets the value of this line as a List of Shorts. Will convert all applicable values into Shorts.
List<String>	getStringList() Gets the value of this line as a List of Strings.
<T> List<T>	getTList(Class<T> clazz) Gets the value of this line as a List of T If the value at the path does not exist or is not a List of T, this will return an empty list.
int	hashCode()
boolean	isShortType()
List<Comment>	separateLastComments() Removes the comments from the end of the list and returns them.
void	setEntries(Iterable<?> entries, boolean keepComments, boolean keepCommentPosition)
void	setShortType(boolean value)
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

cacheType

protected Class<?> cacheType

cached

protected List<?> cached

entries

protected List<CharSequence> entries

Constructor Detail

ListLine

public ListLine(String path,
        boolean shortlist)

Parameters:

path - - The path of this list.

shortlist - - If this list is of the short type.

Throws:

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

Method Detail

getByteList

public final List<Byte> getByteList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Bytes.
Will convert all applicable values into Bytes. If no values are applicable, this will return an empty list.

Specified by:

getByteList in interface IBasicList

Returns:

Requested List of Byte.

getShortList

public final List<Short> getShortList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Shorts.
Will convert all applicable values into Shorts. If no values are applicable, this will return an empty list.

Specified by:

getShortList in interface IBasicList

Returns:

Requested List of Short.

getIntegerList

public final List<Integer> getIntegerList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Integers.
Will convert all applicable values into Integers. If no values are applicable, this will return an empty list.

Specified by:

getIntegerList in interface IBasicList

Returns:

Requested List of Integer.

getLongList

public final List<Long> getLongList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Longs.
Will convert all applicable values into Longs. If no values are applicable, this will return an empty list.

Specified by:

getLongList in interface IBasicList

Returns:

Requested List of Long.

getFloatList

public final List<Float> getFloatList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Floats.
Will convert all applicable values into Floats. If no values are applicable, this will return an empty list.

Specified by:

getFloatList in interface IBasicList

Returns:

Requested List of Float.

getDoubleList

public final List<Double> getDoubleList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Doubles.
Will convert all applicable values into Doubles. If no values are applicable, this will return an empty list.

Specified by:

getDoubleList in interface IBasicList

Returns:

Requested List of Double.

getBooleanList

public final List<Boolean> getBooleanList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Booleans.
Will convert all applicable values into Booleans. If no values are applicable, this will return an empty list.

Specified by:

getBooleanList in interface IBasicList

Returns:

Requested List of Boolean.

getCharacterList

public final List<Character> getCharacterList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Characters.
Will convert all applicable values into Characters. If no values are applicable, this will return an empty list.

Specified by:

getCharacterList in interface IBasicList

Returns:

Requested List of Character.

getStringList

public List<String> getStringList()

Description copied from interface: IBasicList

Gets the value of this line as a List of Strings.

Specified by:

getStringList in interface IBasicList

Returns:

Requested List of String.

getMixedList

public List<Object> getMixedList()

Description copied from interface: IBasicList

Converts whole numbers into Integers or Longs (whichever fits best)
Converts floating point numbers into Doubles
Converts true, false, yes and no into their respective Boolean values

Specified by:

getMixedList in interface IBasicList

Returns:

A list of Integers, Longs, Doubles, Booleans and Strings.

getTList

public <T> List<T> getTList(Class<T> clazz)

Description copied from interface: IBasicList

Gets the value of this line as a List of T
If the value at the path does not exist or is not a List of T, this will return an empty list.

Specified by:

getTList in interface IBasicList

Parameters:

clazz - - The class of the type you want to get.

Returns:

Requested List with instances of the given class.

getComments

public final List<Comment> getComments()

Description copied from interface: IBasicList

Returns a list with all the comments that are inside of this ListLine.

Specified by:

getComments in interface IBasicList

Returns:

A List with Comments

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

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 path sequence.

addEntry

public void addEntry(CharSequence entry)

addEntries

public ListLine addEntries(String entries)

addEntries

public ListLine addEntries(Iterable<?> entries)

setEntries

public void setEntries(Iterable<?> entries,
              boolean keepComments,
              boolean keepCommentPosition)

clear

public final void clear(boolean removeComments)

Parameters:

removeComments - - Should comments be removed as well?

separateLastComments

public final List<Comment> separateLastComments()

Removes the comments from the end of the list and returns them.

Returns:

The comments at the end of this list that were removed.

isShortType

public final boolean isShortType()

Returns:

If this list is a short list ([a, b]) or not.

setShortType

public void setShortType(boolean value)

toString

public String toString()

Specified by:

toString in class Line

equals

public boolean equals(Object obj)

Overrides:

equals in class Line

hashCode

public int hashCode()

Overrides:

hashCode in class Line