org.xblackcat.sjpu.settings

Class Example

java.lang.Object

org.xblackcat.sjpu.settings.Example

public class Example
extends java.lang.Object

18.06.2016 19:54

Method Summary

Modifier and Type	Method and Description
<T> Example	and(java.lang.Class<T> clazz)
<T> Example	and(java.lang.Class<T> clazz, java.lang.String prefix)
Example	brief() Do not generate comments and descriptions to properties except footer, header and default values
static Example	of(java.lang.Class<?> clazz)
static Example	of(java.lang.Class<?> clazz, java.lang.String prefix)
Example	pure() Avoid any kind of comments
void	saveToFile(java.lang.String fileName, java.nio.file.OpenOption... options)
Example	withDebugInfo() Put detailed info for each property to the result with references to target methods
Example	withDefault(java.util.Map<java.lang.String,java.lang.String> defaults)
Example	withDefault(java.lang.String key, java.lang.String value)
Example	withFooter(java.lang.String footer)
Example	withHeader(java.lang.String header)
void	writeTo(java.io.File file)
void	writeTo(java.nio.file.Path file, java.nio.file.OpenOption... options)
void	writeTo(java.io.PrintStream printStream) Saves generated example of configs to specified print stream.
void	writeTo(org.xblackcat.sjpu.util.function.SupplierEx<java.io.PrintStream,java.io.IOException> printStreamSupplier)

Methods inherited from class java.lang.Object

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

Method Detail

of

public static Example of(java.lang.Class<?> clazz)

of

public static Example of(java.lang.Class<?> clazz,
                         java.lang.String prefix)

and

public <T> Example and(java.lang.Class<T> clazz)

and

public <T> Example and(java.lang.Class<T> clazz,
                       java.lang.String prefix)

withHeader

public Example withHeader(java.lang.String header)

withFooter

public Example withFooter(java.lang.String footer)

withDefault

public Example withDefault(java.lang.String key,
                           java.lang.String value)

withDefault

public Example withDefault(java.util.Map<java.lang.String,java.lang.String> defaults)

withDebugInfo

public Example withDebugInfo()

Put detailed info for each property to the result with references to target methods

Returns:

this Example instance

brief

public Example brief()

Do not generate comments and descriptions to properties except footer, header and default values

Returns:

this Example instance

pure

public Example pure()

Avoid any kind of comments

Returns:

this Example instance

writeTo

public void writeTo(org.xblackcat.sjpu.util.function.SupplierEx<java.io.PrintStream,java.io.IOException> printStreamSupplier)
             throws java.io.IOException,
                    SettingsException

Throws:

java.io.IOException

SettingsException

writeTo

public void writeTo(java.io.File file)
             throws java.io.IOException,
                    SettingsException

Throws:

java.io.IOException

SettingsException

saveToFile

public void saveToFile(java.lang.String fileName,
                       java.nio.file.OpenOption... options)
                throws java.io.IOException,
                       SettingsException

Throws:

java.io.IOException

SettingsException

writeTo

public void writeTo(java.nio.file.Path file,
                    java.nio.file.OpenOption... options)
             throws java.io.IOException,
                    SettingsException

Throws:

java.io.IOException

SettingsException

writeTo

public void writeTo(java.io.PrintStream printStream)
             throws java.io.IOException,
                    SettingsException

Saves generated example of configs to specified print stream. Print stream remains open.

Parameters:

printStream - print stream for generated data

Throws:

java.io.IOException

SettingsException