Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.configuration.file.YamlConfigurationOptions Class Reference
Inheritance diagram for org.bukkit.configuration.file.YamlConfigurationOptions:
org.bukkit.configuration.file.FileConfigurationOptions org.bukkit.configuration.MemoryConfigurationOptions org.bukkit.configuration.ConfigurationOptions

Public Member Functions

YamlConfiguration configuration ()
 
YamlConfigurationOptions copyDefaults (boolean value)
 
YamlConfigurationOptions pathSeparator (char value)
 
YamlConfigurationOptions header (String value)
 
YamlConfigurationOptions copyHeader (boolean value)
 
int indent ()
 
YamlConfigurationOptions indent (int value)
 
- Public Member Functions inherited from org.bukkit.configuration.file.FileConfigurationOptions
FileConfiguration configuration ()
 
FileConfigurationOptions copyDefaults (boolean value)
 
FileConfigurationOptions pathSeparator (char value)
 
String header ()
 
FileConfigurationOptions header (String value)
 
boolean copyHeader ()
 
FileConfigurationOptions copyHeader (boolean value)
 
- Public Member Functions inherited from org.bukkit.configuration.MemoryConfigurationOptions
MemoryConfiguration configuration ()
 
MemoryConfigurationOptions copyDefaults (boolean value)
 
MemoryConfigurationOptions pathSeparator (char value)
 
- Public Member Functions inherited from org.bukkit.configuration.ConfigurationOptions
Configuration configuration ()
 
char pathSeparator ()
 
ConfigurationOptions pathSeparator (char value)
 
boolean copyDefaults ()
 
ConfigurationOptions copyDefaults (boolean value)
 

Protected Member Functions

 YamlConfigurationOptions (YamlConfiguration configuration)
 
- Protected Member Functions inherited from org.bukkit.configuration.file.FileConfigurationOptions
 FileConfigurationOptions (MemoryConfiguration configuration)
 
- Protected Member Functions inherited from org.bukkit.configuration.MemoryConfigurationOptions
 MemoryConfigurationOptions (MemoryConfiguration configuration)
 
- Protected Member Functions inherited from org.bukkit.configuration.ConfigurationOptions
 ConfigurationOptions (Configuration configuration)
 

Detailed Description

Various settings for controlling the input and output of a YamlConfiguration

Definition at line 9 of file YamlConfigurationOptions.java.

Member Function Documentation

int org.bukkit.configuration.file.YamlConfigurationOptions.indent ( )

Gets how much spaces should be used to indent each line.

The minimum value this may be is 2, and the maximum is 9.

Returns
How much to indent by

Definition at line 52 of file YamlConfigurationOptions.java.

YamlConfigurationOptions org.bukkit.configuration.file.YamlConfigurationOptions.indent ( int  value)

Sets how much spaces should be used to indent each line.

The minimum value this may be is 2, and the maximum is 9.

Parameters
valueNew indent
Returns
This object, for chaining

Definition at line 64 of file YamlConfigurationOptions.java.

64  {
65  Validate.isTrue(value >= 2, "Indent must be at least 2 characters");
66  Validate.isTrue(value <= 9, "Indent cannot be greater than 9 characters");
67 
68  this.indent = value;
69  return this;
70  }

The documentation for this class was generated from the following file: