public class Toml
extends java.lang.Object
| Modifier and Type | Class and Description |
|---|---|
static class |
Toml.TomlEntry<V> |
| Modifier and Type | Method and Description |
|---|---|
void |
addComment(java.lang.String comment) |
void |
addComments(java.lang.Iterable<java.lang.String> comments) |
void |
addComments(java.lang.String... comments) |
<V> Toml.TomlEntry<V> |
addEntry(java.lang.String key,
V value) |
<V> void |
addEntry(@Nullable Toml.TomlEntry<V> entry) |
void |
addEntryComment(java.lang.String key,
java.lang.String comment) |
void |
addEntryComments(java.lang.String key,
java.lang.Iterable<java.lang.String> comments) |
void |
addEntryComments(java.lang.String key,
java.lang.String... comments) |
Toml |
addTable(java.lang.String name,
boolean array) |
void |
addTable(java.lang.String name,
Toml table)
Renames the input table and adds it
|
void |
clear() |
void |
clear(boolean tables) |
void |
clear(boolean entries,
boolean tables) |
void |
clear(boolean comments,
boolean entries,
boolean tables) |
void |
clearAllComments() |
void |
clearAllEntries() |
void |
clearAllEntryComments() |
void |
clearAllTables() |
void |
clearAnyCommentsMatching(java.lang.String toMatch,
Matching... matchers) |
void |
clearAnyMatching(java.lang.String toMatch,
boolean comments,
boolean entries,
boolean tables,
Matching... matchers) |
void |
clearAnyMatching(java.lang.String toMatch,
boolean entries,
boolean tables,
Matching... matchers) |
void |
clearAnyMatching(java.lang.String toMatch,
boolean tables,
Matching... matchers) |
void |
clearAnyMatching(java.lang.String toMatch,
Matching... matchers) |
void |
clearComments() |
void |
clearCommentsMatching(java.lang.String toMatch,
Matching... matchers) |
void |
clearEntriesMatching(java.lang.String toMatch,
Matching... matchers) |
void |
clearEntryComments(java.lang.String key) |
void |
clearEntryCommentsMatching(java.lang.String key,
java.lang.String toMatch,
Matching... matchers) |
void |
clearTablesMatching(java.lang.String toMatch,
Matching... matchers) |
java.util.Collection<Toml.TomlEntry<?>> |
getAllEntries() |
java.util.List<Toml> |
getAllTables() |
static Toml |
getEmpty() |
Toml.TomlEntry<?> |
getEntry(java.lang.String name) |
Toml.TomlEntry<java.util.List<?>> |
getEntryArray(java.lang.String name) |
Toml.TomlEntry<java.lang.Boolean> |
getEntryBool(java.lang.String name) |
Toml.TomlEntry<java.lang.Float> |
getEntryFloat(java.lang.String name) |
Toml.TomlEntry<java.lang.Integer> |
getEntryInt(java.lang.String name) |
Toml.TomlEntry<java.lang.Number> |
getEntryNumber(java.lang.String name) |
Toml.TomlEntry<java.lang.String> |
getEntryString(java.lang.String name) |
java.util.Map<java.lang.String,java.lang.Object> |
getEntryValuesAsMap() |
<T> java.util.Optional<T> |
getOptional(java.lang.String name)
Return a potentially empty generic optional depending on whether the value is present
|
<T> java.util.Optional<T> |
getOptional(java.lang.String name,
T defVal)
Return a generic optional of the value if it is present or the defVal input.
|
java.util.Optional<java.util.List<?>> |
getOptionalArray(java.lang.String name)
Return a potentially empty list optional depending on whether the value is present
|
java.util.Optional<java.util.List<?>> |
getOptionalArray(java.lang.String name,
@Nullable java.util.List<?> defVal)
Return a list optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Boolean> |
getOptionalBool(java.lang.String name)
Return a potentially empty boolean optional depending on whether the value is present
|
java.util.Optional<java.lang.Boolean> |
getOptionalBool(java.lang.String name,
boolean defVal)
Return a boolean optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Byte> |
getOptionalByte(java.lang.String name)
Return a potentially empty byte optional depending on whether the value is present
|
java.util.Optional<java.lang.Byte> |
getOptionalByte(java.lang.String name,
byte defVal)
Return a byte optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Double> |
getOptionalDouble(java.lang.String name)
Return a potentially empty double optional depending on whether the value is present
|
java.util.Optional<java.lang.Double> |
getOptionalDouble(java.lang.String name,
double defVal)
Return a double optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Float> |
getOptionalFloat(java.lang.String name)
Return a potentially empty float optional depending on whether the value is present
|
java.util.Optional<java.lang.Float> |
getOptionalFloat(java.lang.String name,
float defVal)
Return a float optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Integer> |
getOptionalInt(java.lang.String name)
Return a potentially empty int optional depending on whether the value is present
|
java.util.Optional<java.lang.Integer> |
getOptionalInt(java.lang.String name,
int defVal)
Return an int optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Long> |
getOptionalLong(java.lang.String name)
Return a potentially empty long optional depending on whether the value is present
|
java.util.Optional<java.lang.Long> |
getOptionalLong(java.lang.String name,
long defVal)
Return a long optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Number> |
getOptionalNumber(java.lang.String name)
Return a potentially empty number optional depending on whether the value is present
|
java.util.Optional<java.lang.Number> |
getOptionalNumber(java.lang.String name,
@Nullable java.lang.Number defVal)
Return a number optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.Short> |
getOptionalShort(java.lang.String name)
Return a potentially empty short optional depending on whether the value is present
|
java.util.Optional<java.lang.Short> |
getOptionalShort(java.lang.String name,
short defVal)
Return a short optional of the value if it is present or the defVal input.
|
java.util.Optional<java.lang.String> |
getOptionalString(java.lang.String name)
Return a potentially empty string optional depending on whether the value is present
|
java.util.Optional<java.lang.String> |
getOptionalString(java.lang.String name,
@Nullable java.lang.String defVal)
Return a string optional of the value if it is present or the defVal input.
|
java.util.Optional<Toml> |
getOptionalTable(java.lang.String name) |
java.util.Optional<Toml> |
getOptionalTable(java.lang.String name,
@Nullable Toml defVal) |
java.util.Optional<Toml[]> |
getOptionalTables(java.lang.String name) |
java.util.Optional<Toml[]> |
getOptionalTables(java.lang.String name,
@Nullable Toml[] defVal) |
<V> V |
getOrSetValue(java.lang.String key,
V def) |
java.lang.String |
getPath()
Returns the fully qualified path of this table including all non-root parent tables.
|
Toml |
getTable(java.lang.String name) |
Toml[] |
getTableArray(java.lang.String name) |
<T> T |
getValue(java.lang.String name) |
<T> T |
getValue(java.lang.String name,
T defVal) |
java.util.List<?> |
getValueArray(java.lang.String name) |
java.util.List<?> |
getValueArray(java.lang.String name,
@Nullable java.util.List<?> defVal) |
java.util.List<?> |
getValueArrayOrEmpty(java.lang.String name) |
boolean |
getValueBool(java.lang.String name) |
boolean |
getValueBool(java.lang.String name,
boolean defVal) |
byte |
getValueByte(java.lang.String name) |
byte |
getValueByte(java.lang.String name,
byte defVal) |
double |
getValueDouble(java.lang.String name) |
double |
getValueDouble(java.lang.String name,
double defVal) |
float |
getValueFloat(java.lang.String name) |
float |
getValueFloat(java.lang.String name,
float defVal) |
int |
getValueInt(java.lang.String name) |
int |
getValueInt(java.lang.String name,
int defVal) |
long |
getValueLong(java.lang.String name) |
long |
getValueLong(java.lang.String name,
long defVal) |
java.lang.Number |
getValueNumber(java.lang.String name) |
java.lang.Number |
getValueNumber(java.lang.String name,
@Nullable java.lang.Number defVal) |
short |
getValueShort(java.lang.String name) |
short |
getValueShort(java.lang.String name,
short defVal) |
java.lang.String |
getValueString(java.lang.String name) |
java.lang.String |
getValueString(java.lang.String name,
@Nullable java.lang.String defVal) |
boolean |
hasEntry(java.lang.String name) |
boolean |
hasTable(java.lang.String name) |
java.util.Map<java.lang.String,Parameter<?>> |
parameterizeEntries() |
static Toml |
readBuf(io.netty.buffer.ByteBuf buf) |
static Toml |
readFile(java.io.File file) |
static Toml |
readFile(java.io.File file,
TomlReader reader) |
static Toml |
readFile(java.lang.String filePath) |
static Toml |
readFile(java.lang.String filePath,
TomlReader reader) |
static Toml |
readLines(java.lang.Iterable<java.lang.String> lines) |
static Toml |
readLines(java.lang.Iterable<java.lang.String> lines,
TomlReader reader) |
static Toml |
readPath(java.nio.file.Path path,
java.nio.file.OpenOption... options) |
static Toml |
readPath(java.nio.file.Path path,
TomlReader reader,
java.nio.file.OpenOption... options) |
static Toml |
readStream(java.io.InputStream stream) |
static Toml |
readStream(java.io.InputStream stream,
TomlReader reader) |
static Toml |
readString(java.lang.String tomlString) |
static Toml |
readString(java.lang.String tomlString,
TomlReader reader) |
static Toml |
readURI(java.net.URI uri,
java.nio.file.OpenOption... options) |
static Toml |
readURI(java.net.URI uri,
TomlReader reader,
java.nio.file.OpenOption... options) |
static Toml |
readURL(java.net.URL url) |
static Toml |
readURL(java.net.URL url,
TomlReader reader) |
void |
remapTable(java.lang.String original,
java.lang.String remapped,
int index)
Set the index to -1 to remap all tables with the original name
|
void |
remapTables(java.lang.String original,
java.lang.String remapped) |
void |
removeEntry(java.lang.String name) |
void |
removeTable(java.lang.String name,
int index)
Set index to -1 to remove all elements in a table array with the input name
|
void |
removeTables(java.lang.String name)
Removes all tables with the given name regardless of whether they are singular or in an array
|
java.lang.String |
toString() |
void |
write(io.netty.buffer.ByteBuf buf)
Write this table to a ByteBuf with comments disabled.
|
void |
write(io.netty.buffer.ByteBuf buf,
boolean comments)
Write this table to a ByteBuf with the option of enabling comments to be written.
|
void |
write(java.util.Collection<java.lang.String> lines,
int tabs)
Write this table to a collection of strings with optional formatting and comments enabled.
|
void |
write(java.util.Collection<java.lang.String> lines,
int tabs,
boolean comments)
Write this table to a collection of strings with optional formatting.
|
void |
write(java.lang.StringBuilder builder,
int tabs)
Write this table to a StringBuilder with optional formatting and comments enabled.
|
void |
write(java.lang.StringBuilder builder,
int tabs,
boolean comments)
Write this table to a StringBuilder with optional formatting.
|
public static Toml getEmpty()
public static Toml readBuf(io.netty.buffer.ByteBuf buf) throws TomlParsingException
TomlParsingExceptionpublic static Toml readFile(java.io.File file) throws TomlParsingException, java.io.IOException
TomlParsingExceptionjava.io.IOExceptionpublic static Toml readFile(java.io.File file, TomlReader reader) throws java.io.IOException, TomlParsingException
java.io.IOExceptionTomlParsingExceptionpublic static Toml readFile(java.lang.String filePath) throws TomlParsingException, java.io.IOException
TomlParsingExceptionjava.io.IOExceptionpublic static Toml readFile(java.lang.String filePath, TomlReader reader) throws TomlParsingException, java.io.IOException
TomlParsingExceptionjava.io.IOExceptionpublic static Toml readLines(java.lang.Iterable<java.lang.String> lines) throws TomlParsingException
TomlParsingExceptionpublic static Toml readLines(java.lang.Iterable<java.lang.String> lines, TomlReader reader) throws TomlParsingException
TomlParsingExceptionpublic static Toml readPath(java.nio.file.Path path, java.nio.file.OpenOption... options) throws TomlParsingException, java.io.IOException
TomlParsingExceptionjava.io.IOExceptionpublic static Toml readPath(java.nio.file.Path path, TomlReader reader, java.nio.file.OpenOption... options) throws java.io.IOException, TomlParsingException
java.io.IOExceptionTomlParsingExceptionpublic static Toml readStream(java.io.InputStream stream) throws java.io.IOException, TomlParsingException
java.io.IOExceptionTomlParsingExceptionpublic static Toml readStream(java.io.InputStream stream, TomlReader reader) throws java.io.IOException, TomlParsingException
java.io.IOExceptionTomlParsingExceptionpublic static Toml readString(java.lang.String tomlString) throws TomlParsingException
TomlParsingExceptionpublic static Toml readString(java.lang.String tomlString, TomlReader reader) throws TomlParsingException
TomlParsingExceptionpublic static Toml readURI(java.net.URI uri, java.nio.file.OpenOption... options) throws TomlParsingException, java.io.IOException
TomlParsingExceptionjava.io.IOExceptionpublic static Toml readURI(java.net.URI uri, TomlReader reader, java.nio.file.OpenOption... options) throws TomlParsingException, java.io.IOException
TomlParsingExceptionjava.io.IOExceptionpublic static Toml readURL(java.net.URL url) throws TomlParsingException, java.io.IOException
TomlParsingExceptionjava.io.IOExceptionpublic static Toml readURL(java.net.URL url, TomlReader reader) throws java.io.IOException, TomlParsingException
java.io.IOExceptionTomlParsingExceptionpublic void addComment(java.lang.String comment)
public void addComments(java.lang.Iterable<java.lang.String> comments)
public void addComments(java.lang.String... comments)
public <V> Toml.TomlEntry<V> addEntry(java.lang.String key, V value)
public <V> void addEntry(@Nullable
@Nullable Toml.TomlEntry<V> entry)
public void addEntryComment(java.lang.String key,
java.lang.String comment)
public void addEntryComments(java.lang.String key,
java.lang.Iterable<java.lang.String> comments)
public void addEntryComments(java.lang.String key,
java.lang.String... comments)
public Toml addTable(java.lang.String name, boolean array) throws TomlWritingException
TomlWritingExceptionpublic void addTable(java.lang.String name,
Toml table)
public void clear()
public void clear(boolean tables)
public void clear(boolean entries,
boolean tables)
public void clear(boolean comments,
boolean entries,
boolean tables)
public void clearAllComments()
public void clearAllEntries()
public void clearAllEntryComments()
public void clearAllTables()
public void clearAnyMatching(java.lang.String toMatch,
Matching... matchers)
public void clearAnyMatching(java.lang.String toMatch,
boolean tables,
Matching... matchers)
public void clearAnyMatching(java.lang.String toMatch,
boolean entries,
boolean tables,
Matching... matchers)
public void clearAnyMatching(java.lang.String toMatch,
boolean comments,
boolean entries,
boolean tables,
Matching... matchers)
public void clearAnyCommentsMatching(java.lang.String toMatch,
Matching... matchers)
public void clearComments()
public void clearCommentsMatching(java.lang.String toMatch,
Matching... matchers)
public void clearEntriesMatching(java.lang.String toMatch,
Matching... matchers)
public void clearEntryCommentsMatching(java.lang.String key,
java.lang.String toMatch,
Matching... matchers)
public void clearEntryComments(java.lang.String key)
public void clearTablesMatching(java.lang.String toMatch,
Matching... matchers)
public java.util.Collection<Toml.TomlEntry<?>> getAllEntries()
public java.util.List<Toml> getAllTables()
public Toml.TomlEntry<?> getEntry(java.lang.String name)
public Toml.TomlEntry<java.util.List<?>> getEntryArray(java.lang.String name)
public Toml.TomlEntry<java.lang.Boolean> getEntryBool(java.lang.String name)
public Toml.TomlEntry<java.lang.Float> getEntryFloat(java.lang.String name)
public Toml.TomlEntry<java.lang.Integer> getEntryInt(java.lang.String name)
public Toml.TomlEntry<java.lang.Number> getEntryNumber(java.lang.String name)
public Toml.TomlEntry<java.lang.String> getEntryString(java.lang.String name)
public java.util.Map<java.lang.String,java.lang.Object> getEntryValuesAsMap()
public <T> java.util.Optional<T> getOptional(java.lang.String name)
public <T> java.util.Optional<T> getOptional(java.lang.String name,
@Nullable
T defVal)
public java.util.Optional<java.util.List<?>> getOptionalArray(java.lang.String name)
public java.util.Optional<java.util.List<?>> getOptionalArray(java.lang.String name,
@Nullable
@Nullable java.util.List<?> defVal)
public java.util.Optional<java.lang.Boolean> getOptionalBool(java.lang.String name)
public java.util.Optional<java.lang.Boolean> getOptionalBool(java.lang.String name,
boolean defVal)
public java.util.Optional<java.lang.Byte> getOptionalByte(java.lang.String name)
public java.util.Optional<java.lang.Byte> getOptionalByte(java.lang.String name,
byte defVal)
public java.util.Optional<java.lang.Double> getOptionalDouble(java.lang.String name)
public java.util.Optional<java.lang.Double> getOptionalDouble(java.lang.String name,
double defVal)
public java.util.Optional<java.lang.Float> getOptionalFloat(java.lang.String name)
public java.util.Optional<java.lang.Float> getOptionalFloat(java.lang.String name,
float defVal)
public java.util.Optional<java.lang.Integer> getOptionalInt(java.lang.String name)
public java.util.Optional<java.lang.Integer> getOptionalInt(java.lang.String name,
int defVal)
public java.util.Optional<java.lang.Long> getOptionalLong(java.lang.String name)
public java.util.Optional<java.lang.Long> getOptionalLong(java.lang.String name,
long defVal)
public java.util.Optional<java.lang.Number> getOptionalNumber(java.lang.String name)
public java.util.Optional<java.lang.Number> getOptionalNumber(java.lang.String name,
@Nullable
@Nullable java.lang.Number defVal)
public java.util.Optional<java.lang.Short> getOptionalShort(java.lang.String name)
public java.util.Optional<java.lang.Short> getOptionalShort(java.lang.String name,
short defVal)
public java.util.Optional<java.lang.String> getOptionalString(java.lang.String name)
public java.util.Optional<java.lang.String> getOptionalString(java.lang.String name,
@Nullable
@Nullable java.lang.String defVal)
public java.util.Optional<Toml> getOptionalTable(java.lang.String name)
public java.util.Optional<Toml> getOptionalTable(java.lang.String name, @Nullable @Nullable Toml defVal)
public java.util.Optional<Toml[]> getOptionalTables(java.lang.String name)
public java.util.Optional<Toml[]> getOptionalTables(java.lang.String name, @Nullable @Nullable Toml[] defVal)
public <V> V getOrSetValue(java.lang.String key,
V def)
public java.lang.String getPath()
public Toml getTable(java.lang.String name)
public Toml[] getTableArray(java.lang.String name)
public <T> T getValue(java.lang.String name)
public <T> T getValue(java.lang.String name,
@Nullable
T defVal)
public java.util.List<?> getValueArray(java.lang.String name)
public java.util.List<?> getValueArray(java.lang.String name,
@Nullable
@Nullable java.util.List<?> defVal)
public java.util.List<?> getValueArrayOrEmpty(java.lang.String name)
public boolean getValueBool(java.lang.String name)
public boolean getValueBool(java.lang.String name,
boolean defVal)
public byte getValueByte(java.lang.String name)
public byte getValueByte(java.lang.String name,
byte defVal)
public double getValueDouble(java.lang.String name)
public double getValueDouble(java.lang.String name,
double defVal)
public float getValueFloat(java.lang.String name)
public float getValueFloat(java.lang.String name,
float defVal)
public int getValueInt(java.lang.String name)
public int getValueInt(java.lang.String name,
int defVal)
public long getValueLong(java.lang.String name)
public long getValueLong(java.lang.String name,
long defVal)
public java.lang.Number getValueNumber(java.lang.String name)
public java.lang.Number getValueNumber(java.lang.String name,
@Nullable
@Nullable java.lang.Number defVal)
public short getValueShort(java.lang.String name)
public short getValueShort(java.lang.String name,
short defVal)
public java.lang.String getValueString(java.lang.String name)
public java.lang.String getValueString(java.lang.String name,
@Nullable
@Nullable java.lang.String defVal)
public boolean hasEntry(java.lang.String name)
public boolean hasTable(java.lang.String name)
public java.util.Map<java.lang.String,Parameter<?>> parameterizeEntries()
public void removeTables(java.lang.String name)
public void removeTable(java.lang.String name,
int index)
public void removeEntry(java.lang.String name)
public void remapTables(java.lang.String original,
java.lang.String remapped)
public void remapTable(java.lang.String original,
java.lang.String remapped,
int index)
public java.lang.String toString()
toString in class java.lang.Objectpublic void write(java.lang.StringBuilder builder,
int tabs)
builder - A StringBuilder output of the written tabletabs - The number of tabs to use when writing the table. Set -1 to disable formatting entirelypublic void write(java.lang.StringBuilder builder,
int tabs,
boolean comments)
builder - A StringBuilder output of the written tabletabs - The number of tabs to use when writing the table. Set -1 to disable formatting entirelycomments - Enables the writing of commentspublic void write(java.util.Collection<java.lang.String> lines,
int tabs)
lines - A collections of strings where each entry is assumed to be a separate linetabs - The number of tabs to use when writing the table. Set -1 to disable formatting entirelypublic void write(java.util.Collection<java.lang.String> lines,
int tabs,
boolean comments)
lines - A collections of strings where each entry is assumed to be a separate linetabs - The number of tabs to use when writing the table. Set -1 to disable formatting entirelycomments - Enables the writing of commentspublic void write(io.netty.buffer.ByteBuf buf)
buf - The buffer to be writtenpublic void write(io.netty.buffer.ByteBuf buf,
boolean comments)
buf - The buffer to be writtencomments - Enables the writing of comments