org.springframework.boot.configurationmetadata

Class ConfigurationMetadataRepositoryJsonBuilder

java.lang.Object

org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder

public final class ConfigurationMetadataRepositoryJsonBuilder
extends Object

Load a ConfigurationMetadataRepository from the content of arbitrary resource(s).

Since:

1.3.0

Author:

Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	UTF_8 UTF-8 Charset.

Method Summary

Modifier and Type	Method and Description
ConfigurationMetadataRepository	build() Build a ConfigurationMetadataRepository with the current state of this builder.
static ConfigurationMetadataRepositoryJsonBuilder	create() Create a new builder instance using UTF_8 as the default charset.
static ConfigurationMetadataRepositoryJsonBuilder	create(Charset defaultCharset) Create a new builder instance using the specified default Charset.
static ConfigurationMetadataRepositoryJsonBuilder	create(InputStream... inputStreams) Create a new builder instance using UTF_8 as the default charset and the specified json resource.
ConfigurationMetadataRepositoryJsonBuilder	withJsonResource(InputStream inputStream) Add the content of a ConfigurationMetadataRepository defined by the specified InputStream json document using the default charset.
ConfigurationMetadataRepositoryJsonBuilder	withJsonResource(InputStream inputStream, Charset charset) Add the content of a ConfigurationMetadataRepository defined by the specified InputStream json document using the specified Charset.

Methods inherited from class java.lang.Object

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

Field Detail

UTF_8

public static final Charset UTF_8

UTF-8 Charset.

Method Detail

withJsonResource

public ConfigurationMetadataRepositoryJsonBuilder withJsonResource(InputStream inputStream)
                                                            throws IOException

Add the content of a ConfigurationMetadataRepository defined by the specified InputStream json document using the default charset. If this metadata repository holds items that were loaded previously, these are ignored.

Leaves the stream open when done.

Parameters:

inputStream - the source input stream

Returns:

this builder

Throws:

IOException - in case of I/O errors

withJsonResource

public ConfigurationMetadataRepositoryJsonBuilder withJsonResource(InputStream inputStream,
                                                                   Charset charset)
                                                            throws IOException

Add the content of a ConfigurationMetadataRepository defined by the specified InputStream json document using the specified Charset. If this metadata repository holds items that were loaded previously, these are ignored.

Leaves the stream open when done.

Parameters:

inputStream - the source input stream

charset - the charset of the input

Returns:

this builder

Throws:

IOException - in case of I/O errors

build

public ConfigurationMetadataRepository build()

Build a ConfigurationMetadataRepository with the current state of this builder.

Returns:

this builder

create

public static ConfigurationMetadataRepositoryJsonBuilder create(InputStream... inputStreams)
                                                         throws IOException

Create a new builder instance using UTF_8 as the default charset and the specified json resource.

Parameters:

inputStreams - the source input streams

Returns:

a new ConfigurationMetadataRepositoryJsonBuilder instance.

Throws:

IOException - on error

create

public static ConfigurationMetadataRepositoryJsonBuilder create()

Create a new builder instance using UTF_8 as the default charset.

Returns:

a new ConfigurationMetadataRepositoryJsonBuilder instance.

create

public static ConfigurationMetadataRepositoryJsonBuilder create(Charset defaultCharset)

Create a new builder instance using the specified default Charset.

Parameters:

defaultCharset - the default charset to use

Returns:

a new ConfigurationMetadataRepositoryJsonBuilder instance.