Package cn.nukkit.utils

Class Config

java.lang.Object

cn.nukkit.utils.Config

public class Config
extends Object

Author:

MagicDroidX (Nukkit)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CNF
static final int	DETECT
static final int	ENUM
static final int	ENUMERATION
static final Map<String,Integer>	format
static final int	JSON
static final int	PROPERTIES
static final int	YAML

Constructor Summary

Constructors

Constructor	Description
Config()	Constructor for Config (YAML) instance with undefined file object
Config(int type)	Constructor for Config instance with undefined file object
Config(File file)
Config(File file, int type)
Config(File file, int type, ConfigSection defaultMap)
Config(File file, int type, LinkedHashMap<String,Object> defaultMap)	Deprecated.
Config(String file)
Config(String file, int type)
Config(String file, int type, ConfigSection defaultMap)
Config(String file, int type, LinkedHashMap<String,Object> defaultMap)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	check()
boolean	exists(String key)
boolean	exists(String key, boolean ignoreCase)
Object	get(String key)
<T> T	get(String key, T defaultValue)
Map<String,Object>	getAll()
boolean	getBoolean(String key)
boolean	getBoolean(String key, boolean defaultValue)
List<Boolean>	getBooleanList(String key)
List<Byte>	getByteList(String key)
List<Character>	getCharacterList(String key)
double	getDouble(String key)
double	getDouble(String key, double defaultValue)
List<Double>	getDoubleList(String key)
List<Float>	getFloatList(String key)
int	getInt(String key)
int	getInt(String key, int defaultValue)
List<Integer>	getIntegerList(String key)
Set<String>	getKeys()
Set<String>	getKeys(boolean child)
List	getList(String key)
List	getList(String key, List defaultList)
long	getLong(String key)
long	getLong(String key, long defaultValue)
List<Long>	getLongList(String key)
List<Map>	getMapList(String key)
Object	getNested(String key)	Deprecated. use get(String) instead
<T> T	getNested(String key, T defaultValue)	Deprecated. use get(String, Object) instead
<T> T	getNestedAs(String key, Class<T> type)	Deprecated. use get(String) instead
ConfigSection	getRootSection()	Get root (main) config section of the Config
ConfigSection	getSection(String key)
ConfigSection	getSections()
ConfigSection	getSections(String key)
List<Short>	getShortList(String key)
String	getString(String key)
String	getString(String key, String defaultValue)
List<String>	getStringList(String key)
boolean	isBoolean(String key)
boolean	isCorrect()
boolean	isDouble(String key)
boolean	isInt(String key)
boolean	isList(String key)
boolean	isLong(String key)
boolean	isSection(String key)
boolean	isString(String key)
boolean	load(InputStream inputStream)
boolean	load(String file)
boolean	load(String file, int type)
boolean	load(String file, int type, ConfigSection defaultMap)
boolean	loadAsJson(InputStream inputStream, com.google.gson.Gson gson)
void	reload()
void	remove(String key)
void	removeNested(String key)	Deprecated. use remove(String) instead
boolean	save()
boolean	save(File file)
boolean	save(File file, boolean async)	Save configuration into provided file.
boolean	save(Boolean async)
boolean	saveAsJson(boolean async, com.google.gson.Gson gson)
boolean	saveAsJson(File file, boolean async, com.google.gson.Gson gson)
void	set(String key, Object value)
void	setAll(ConfigSection section)
void	setAll(LinkedHashMap<String,Object> map)
int	setDefault(ConfigSection map)
int	setDefault(LinkedHashMap<String,Object> map)

Methods inherited from class java.lang.Object

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

Field Details

DETECT

public static final int DETECT

See Also:

• Constant Field Values

PROPERTIES

public static final int PROPERTIES

See Also:

• Constant Field Values

CNF

public static final int CNF

See Also:

• Constant Field Values

JSON

public static final int JSON

See Also:

• Constant Field Values

YAML

public static final int YAML

See Also:

• Constant Field Values

ENUM

public static final int ENUM

See Also:

• Constant Field Values

ENUMERATION

public static final int ENUMERATION

See Also:

• Constant Field Values

format

public static final Map<String,Integer> format

Constructor Details

Config

public Config(int type)

Constructor for Config instance with undefined file object

Parameters:

type - - Config type

Config

public Config()

Constructor for Config (YAML) instance with undefined file object

Config

public Config(String file)

Config

public Config(File file)

Config

public Config(String file,
 int type)

Config

public Config(File file,
 int type)

Config

@Deprecated
public Config(String file,
 int type,
 LinkedHashMap<String,Object> defaultMap)

Deprecated.

Config

public Config(String file,
 int type,
 ConfigSection defaultMap)

Config

public Config(File file,
 int type,
 ConfigSection defaultMap)

Config

@Deprecated
public Config(File file,
 int type,
 LinkedHashMap<String,Object> defaultMap)

Deprecated.

Method Details

reload

public void reload()

load

public boolean load(String file)

load

public boolean load(String file,
 int type)

load

public boolean load(String file,
 int type,
 ConfigSection defaultMap)

load

public boolean load(InputStream inputStream)

loadAsJson

@PowerNukkitOnly
@Since("1.5.2.0-PN")
public boolean loadAsJson(@Nullable
 InputStream inputStream,
 @NotNull
 com.google.gson.Gson gson)

check

public boolean check()

isCorrect

public boolean isCorrect()

save

public boolean save(File file,
 boolean async)

Save configuration into provided file. Internal file object will be set to new file.

Parameters:

file -

async -

Returns:

save

public boolean save(File file)

saveAsJson

@PowerNukkitOnly
@Since("1.5.2.0-PN")
public boolean saveAsJson(@NotNull
 File file,
 boolean async,
 @NotNull
 com.google.gson.Gson gson)

save

public boolean save()

saveAsJson

@PowerNukkitOnly
@Since("1.5.2.0-PN")
public boolean saveAsJson(boolean async,
 @NotNull
 com.google.gson.Gson gson)

save

public boolean save(Boolean async)

set

public void set(String key,
 Object value)

get

public Object get(String key)

get

public <T> T get(String key,
 T defaultValue)

getSection

public ConfigSection getSection(String key)

isSection

public boolean isSection(String key)

getSections

public ConfigSection getSections(String key)

getSections

public ConfigSection getSections()

getInt

public int getInt(String key)

getInt

public int getInt(String key,
 int defaultValue)

isInt

public boolean isInt(String key)

getLong

public long getLong(String key)

getLong

public long getLong(String key,
 long defaultValue)

isLong

public boolean isLong(String key)

getDouble

public double getDouble(String key)

getDouble

public double getDouble(String key,
 double defaultValue)

isDouble

public boolean isDouble(String key)

getString

public String getString(String key)

getString

public String getString(String key,
 String defaultValue)

isString

public boolean isString(String key)

getBoolean

public boolean getBoolean(String key)

getBoolean

public boolean getBoolean(String key,
 boolean defaultValue)

isBoolean

public boolean isBoolean(String key)

getList

public List getList(String key)

getList

public List getList(String key,
 List defaultList)

isList

public boolean isList(String key)

getStringList

public List<String> getStringList(String key)

getIntegerList

public List<Integer> getIntegerList(String key)

getBooleanList

public List<Boolean> getBooleanList(String key)

getDoubleList

public List<Double> getDoubleList(String key)

getFloatList

public List<Float> getFloatList(String key)

getLongList

public List<Long> getLongList(String key)

getByteList

public List<Byte> getByteList(String key)

getCharacterList

public List<Character> getCharacterList(String key)

getShortList

public List<Short> getShortList(String key)

getMapList

public List<Map> getMapList(String key)

setAll

public void setAll(LinkedHashMap<String,Object> map)

setAll

public void setAll(ConfigSection section)

exists

public boolean exists(String key)

exists

public boolean exists(String key,
 boolean ignoreCase)

remove

public void remove(String key)

getAll

public Map<String,Object> getAll()

getRootSection

public ConfigSection getRootSection()

Get root (main) config section of the Config

Returns:

setDefault

public int setDefault(LinkedHashMap<String,Object> map)

setDefault

public int setDefault(ConfigSection map)

getNested

@Deprecated
public Object getNested(String key)

Deprecated.

use get(String) instead

getNested

@Deprecated
public <T> T getNested(String key,
 T defaultValue)

Deprecated.

use get(String, Object) instead

getNestedAs

@Deprecated
public <T> T getNestedAs(String key,
 Class<T> type)

Deprecated.

use get(String) instead

removeNested

@Deprecated
public void removeNested(String key)

Deprecated.

use remove(String) instead

getKeys

public Set<String> getKeys()

getKeys

public Set<String> getKeys(boolean child)