org.jboss.logging.tools.examples

Class ContentWriterBuilder

java.lang.Object

org.jboss.logging.tools.examples.ContentWriterBuilder

public class ContentWriterBuilder
extends Object

Builds a ContentWriter.

Author:

James R. Perkins

Method Summary

Modifier and Type	Method and Description
ContentWriter	build() Creates the ContentWriter.
static ContentWriterBuilder	of(Path path) Creates a new builder.
ContentWriterBuilder	setAppend(boolean append) Indicates whether or not the content should be appended to any previous content already written.
ContentWriterBuilder	setEncoding(String encoding) Set the encoding of for the content.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ContentWriterBuilder of(Path path)

Creates a new builder.

Parameters:

path - the path where the content should be written to, cannot be null

Returns:

the new content writer

setEncoding

public ContentWriterBuilder setEncoding(String encoding)

Set the encoding of for the content. If the encoding is not a valid Charset a default encoding of StandardCharsets.UTF_8 will be used.

Parameters:

encoding - the encoding to use

Returns:

this builder

setAppend

public ContentWriterBuilder setAppend(boolean append)

Indicates whether or not the content should be appended to any previous content already written. The default value is true.

Parameters:

append - false if the created writer should overwrite previously written content, otherwise true

Returns:

this builder

build

public ContentWriter build()
                    throws IOException

Creates the ContentWriter.

Returns:

the created writer

Throws:

IOException - if a failure creating the writer occurs