net.dzikoysk.cdn

Class Cdn

java.lang.Object

net.dzikoysk.cdn.Cdn

public final class Cdn
extends Object

The main class of Cdn library that expose methods related to process of loading/rendering configurations. You can built an instance using configure() method or you can take a look at predefined instances in CdnFactory.

Method Summary

Modifier and Type	Method and Description
static CdnSettings	configure() Build custom CDN instance.
CdnSettings	getSettings() Get settings used by this CDN instance
Configuration	load(File file) Load configuration located in the given file with UTF-8 charset.
Configuration	load(File file, Charset charset) Load configuration located in the given file with the provided charset.
<T> T	load(File file, Charset charset, Class<T> configurationClass) Load configuration located in the given file as the given class using the given charset
<T> T	load(File file, Class<T> configurationClass) Load configuration located in the given file as the given class using UTF-8 charset.
Configuration	load(Path file) Load configuration located in the given file with UTF-8 charset.
Configuration	load(Path file, Charset charset) Load configuration located in the given file with the provided charset.
<T> T	load(Path file, Charset charset, Class<T> configurationClass) Load configuration located in the given file as the given class using the given charset
<T> T	load(Path file, Class<T> configurationClass) Load configuration located in the given file as the given class using UTF-8 charset.
Configuration	load(String source) Load configuration as default Configuration structure.
<T> T	load(String source, Class<T> configurationClass) Load configuration from the given source and map default Configuration structure into the given configuration class.
<T> T	load(String source, T instance) Load configuration from the given source and map default Configuration structure into the given configuration class.
String	render(Element<?> element) Convert the given configuration instance to the output string
void	render(Element<?> element, File output) Convert the given instance using render(net.dzikoysk.cdn.model.Element) method and save the output in the given file using UTF-8 charset.
void	render(Element<?> element, Path output) Convert the given instance using render(net.dzikoysk.cdn.model.Element) method and save the output in the given file using UTF-8 charset.
String	render(Object entity) Convert the given instance to the output string
void	render(Object entity, File output) Convert the given instance using render(Object) method and save the output in the given file using UTF-8 charset.
void	render(Object entity, Path output) Convert the given instance using render(Object) method and save the output in the given file using UTF-8 charset.

Methods inherited from class java.lang.Object

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

Method Detail

configure

public static CdnSettings configure()

Build custom CDN instance. For standard usage like CDN, JSON, YAML-like formats you can use predefined instances available in CdnFactory class.

Returns:

default instance of settings

See Also:

CdnFactory

load

public Configuration load(String source)

Load configuration as default Configuration structure.

Parameters:

source - the source to load

Returns:

the parsed configuration

load

public Configuration load(File file)
                   throws IOException

Load configuration located in the given file with UTF-8 charset. To load files with other charset, use load(java.io.File, java.nio.charset.Charset).

Parameters:

file - the file to load

Returns:

a loaded configuration

Throws:

IOException - in case of any IO related error

load

public Configuration load(Path file)
                   throws IOException

Load configuration located in the given file with UTF-8 charset. To load files with other charset, use load(java.io.File, java.nio.charset.Charset).

Parameters:

file - the file to load

Returns:

a loaded configuration

Throws:

IOException - in case of any IO related error

load

public Configuration load(File file,
                          Charset charset)
                   throws IOException

Load configuration located in the given file with the provided charset.

Parameters:

file - the file to load

charset - the charset to use

Returns:

a loaded configuration

Throws:

IOException - in case of any IO related error

load

public Configuration load(Path file,
                          Charset charset)
                   throws IOException

Load configuration located in the given file with the provided charset.

Parameters:

file - the file to load

charset - the charset to use

Returns:

a loaded configuration

Throws:

IOException - in case of any IO related error

load

public <T> T load(String source,
                  Class<T> configurationClass)
           throws Exception

Load configuration from the given source and map default Configuration structure into the given configuration class.

Type Parameters:

T - the expected type

Parameters:

source - the source to load

configurationClass - the class to use

Returns:

an instance of configuration class mapped from Configuration structure

Throws:

Exception - in case of any deserialization error

load

public <T> T load(String source,
                  T instance)
           throws Exception

Load configuration from the given source and map default Configuration structure into the given configuration class.

Type Parameters:

T - the expected type

Parameters:

source - the source to load

instance - the instance to use

Returns:

an instance of configuration class mapped from Configuration structure

Throws:

Exception - in case of any deserialization error

load

public <T> T load(File file,
                  Class<T> configurationClass)
           throws Exception

Load configuration located in the given file as the given class using UTF-8 charset. To load files with other charset, use load(java.io.File, java.nio.charset.Charset, Class)

Type Parameters:

T - the expected type

Parameters:

file - the file to load

configurationClass - the class to use

Returns:

an instance of configuration class

Throws:

Exception - in case of any deserialization/IO error

load

public <T> T load(Path file,
                  Class<T> configurationClass)
           throws Exception

Load configuration located in the given file as the given class using UTF-8 charset. To load files with other charset, use load(java.io.File, java.nio.charset.Charset, Class)

Type Parameters:

T - the expected type

Parameters:

file - the file to load

configurationClass - the class to use

Returns:

an instance of configuration class

Throws:

Exception - in case of any deserialization/IO error

load

public <T> T load(File file,
                  Charset charset,
                  Class<T> configurationClass)
           throws Exception

Load configuration located in the given file as the given class using the given charset

Type Parameters:

T - the expected type

Parameters:

file - the file to load

configurationClass - the class to use

Returns:

an instance of configuration class

Throws:

Exception - in case of any deserialization/IO error

load

public <T> T load(Path file,
                  Charset charset,
                  Class<T> configurationClass)
           throws Exception

Load configuration located in the given file as the given class using the given charset

Type Parameters:

T - the expected type

Parameters:

file - the file to load

configurationClass - the class to use

Returns:

an instance of configuration class

Throws:

Exception - in case of any deserialization/IO error

render

public String render(Object entity)

Convert the given instance to the output string

Parameters:

entity - the instance to convert

Returns:

the rendered output

render

public void render(Object entity,
                   File output)
            throws IOException

Convert the given instance using render(Object) method and save the output in the given file using UTF-8 charset.

Parameters:

entity - the instance to convert

output - the output file

Throws:

IOException

render

public void render(Object entity,
                   Path output)
            throws IOException

Convert the given instance using render(Object) method and save the output in the given file using UTF-8 charset.

Parameters:

entity - the instance to convert

output - the output file

Throws:

IOException

render

public String render(Element<?> element)

Convert the given configuration instance to the output string

Parameters:

element - the element to convert

Returns:

the rendered output

render

public void render(Element<?> element,
                   File output)
            throws IOException

Convert the given instance using render(net.dzikoysk.cdn.model.Element) method and save the output in the given file using UTF-8 charset.

Parameters:

element - the element to convert

output - the output file

Throws:

IOException

render

public void render(Element<?> element,
                   Path output)
            throws IOException

Convert the given instance using render(net.dzikoysk.cdn.model.Element) method and save the output in the given file using UTF-8 charset.

Parameters:

element - the element to convert

output - the output file

Throws:

IOException

getSettings

public CdnSettings getSettings()

Get settings used by this CDN instance

Returns:

settings used by this instance