com.electronwill.nightconfig.toml

Class TomlWriter

java.lang.Object

com.electronwill.nightconfig.toml.TomlWriter

All Implemented Interfaces:

com.electronwill.nightconfig.core.io.ConfigWriter

public final class TomlWriter
extends java.lang.Object
implements com.electronwill.nightconfig.core.io.ConfigWriter

Constructor Summary

Constructors

Constructor and Description
TomlWriter()

Method Summary

Modifier and Type	Method and Description
boolean	isHidingRedundantLevels() Gets the "hide redundant levels" policy.
boolean	isLenientWithBareKeys()
boolean	isOmitIntermediateLevels()
void	setHideRedundantLevels(boolean hideRedundantLevels) Sets whether redundant intermediate levels should be hidden or written to the TOML output.
void	setIndent(com.electronwill.nightconfig.core.io.IndentStyle indentStyle) Changes the indentation style using a predefined style.
void	setIndent(java.lang.String indentString) Changes the indentation style using a custom string.
void	setIndentArrayElementsPredicate(java.util.function.Predicate<java.util.List<?>> predicate)
void	setLenientWithBareKeys(boolean lenientBareKeys)
void	setNewline(com.electronwill.nightconfig.core.io.NewlineStyle newlineStyle)
void	setNewline(java.lang.String newlineString) Changes the string to write for newlines.
void	setOmitIntermediateLevels(boolean omitIntermediateLevels)
void	setWriteStringLiteralPredicate(java.util.function.Predicate<java.lang.String> predicate)
void	setWriteStringMultilinePredicate(java.util.function.Predicate<java.lang.String> predicate)
void	setWriteTableInlinePredicate(java.util.function.Predicate<com.electronwill.nightconfig.core.UnmodifiableConfig> predicate)
void	write(com.electronwill.nightconfig.core.UnmodifiableConfig config, java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.electronwill.nightconfig.core.io.ConfigWriter

write, write, write, write, write, write, write, writeToString

Constructor Detail

TomlWriter

public TomlWriter()

Method Detail

write

public void write(com.electronwill.nightconfig.core.UnmodifiableConfig config,
                  java.io.Writer writer)

Specified by:

write in interface com.electronwill.nightconfig.core.io.ConfigWriter

isHidingRedundantLevels

public boolean isHidingRedundantLevels()

Gets the "hide redundant levels" policy. It is enabled by default.

If set to false, a possible output would be:

 
 [table]
 [table.sub]
 [table.sub.nested]
 value = 1
 
 

If set to true, the same config will be written as:

 
 [table.sub.nested]
 value = 1
 
 

Returns:

true if this writer hides the redundant intermediate levels.

setHideRedundantLevels

public void setHideRedundantLevels(boolean hideRedundantLevels)

Sets whether redundant intermediate levels should be hidden or written to the TOML output.

See Also:

isHidingRedundantLevels()

isOmitIntermediateLevels

public boolean isOmitIntermediateLevels()

See Also:

isHidingRedundantLevels()

setOmitIntermediateLevels

public void setOmitIntermediateLevels(boolean omitIntermediateLevels)

See Also:

setHideRedundantLevels(boolean)

isLenientWithBareKeys

public boolean isLenientWithBareKeys()

setLenientWithBareKeys

public void setLenientWithBareKeys(boolean lenientBareKeys)

setWriteTableInlinePredicate

public void setWriteTableInlinePredicate(java.util.function.Predicate<com.electronwill.nightconfig.core.UnmodifiableConfig> predicate)

setWriteStringLiteralPredicate

public void setWriteStringLiteralPredicate(java.util.function.Predicate<java.lang.String> predicate)

setWriteStringMultilinePredicate

public void setWriteStringMultilinePredicate(java.util.function.Predicate<java.lang.String> predicate)

setIndentArrayElementsPredicate

public void setIndentArrayElementsPredicate(java.util.function.Predicate<java.util.List<?>> predicate)

setIndent

public void setIndent(com.electronwill.nightconfig.core.io.IndentStyle indentStyle)

Changes the indentation style using a predefined style. For example, to indent with four spaces, call setIndent(IndentStyle.SPACES_4).

setIndent

public void setIndent(java.lang.String indentString)

Changes the indentation style using a custom string. For example, to indent with tabs, call setIndent("\t").

setNewline

public void setNewline(com.electronwill.nightconfig.core.io.NewlineStyle newlineStyle)

setNewline

public void setNewline(java.lang.String newlineString)

Changes the string to write for newlines. By default, the system's line separator is used.