Package space.arim.dazzleconf.backend

Class PathRoot

java.lang.Object

space.arim.dazzleconf.backend.PathRoot

All Implemented Interfaces:

BinaryRoot, DataRoot, ReadableRoot

public final class PathRoot
extends Object
implements ReadableRoot, BinaryRoot

A data root from a file path.

Both textual and binary operations can be performed on this data root. If textual operations are used, then the charset specified at construction will be used to provide encoding.

Nested Class Summary

Nested classes/interfaces inherited from interface space.arim.dazzleconf.backend.DataRoot

DataRoot.Operation<R,U>

Constructor Summary

Constructors

Constructor	Description
PathRoot(@NonNull Path path)	Creates from a path.
PathRoot(@NonNull Path path, @NonNull Charset charset)	Creates from a path and a charset.

Method Summary

Modifier and Type	Method	Description
boolean	dataExists()	Checks whether the data is known to exist.
<R> R	openInputStream(@NonNull DataRoot.Operation<R,@NonNull InputStream> operation)	Opens an input stream for the data
<R> R	openOutputStream(@NonNull DataRoot.Operation<R,@NonNull OutputStream> operation)	Opens an output stream to the data
<R> R	openReadChannel(@NonNull DataRoot.Operation<R,@NonNull ReadableByteChannel> operation)	Opens a read channel for the data
<R> R	openReader(@NonNull DataRoot.Operation<R,@NonNull Reader> operation)	Opens a reader to the data
<R> R	openWriteChannel(@NonNull DataRoot.Operation<R,@NonNull WritableByteChannel> operation)	Opens a write channel to the data
<R> R	openWriter(@NonNull DataRoot.Operation<R,@NonNull Writer> operation)	Opens a writer for the data
@NonNull String	readString()	Reads to a string
void	writeString(@NonNull String content)	Writes to a string

Methods inherited from class java.lang.Object

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

Constructor Details

PathRoot

public PathRoot(@NonNull Path path,
 @NonNull Charset charset)

Creates from a path and a charset.

The charset will be used for operations which read or write textual data.

Parameters:

path - the path

charset - the charset

PathRoot

public PathRoot(@NonNull Path path)

Creates from a path.

UTF-8 charset will be used for operations which read or write textual data.

Parameters:

path - the path

Method Details

dataExists

public boolean dataExists()
                   throws IOException

Description copied from interface: DataRoot

Checks whether the data is known to exist.

Specified by:

dataExists in interface DataRoot

Returns:

true if the data is known to be present, false if not present or if its existence cannot be determined

Throws:

IOException - if checking for data existence failed

readString

public @NonNull String readString()
                           throws IOException

Description copied from interface: ReadableRoot

Reads to a string

Specified by:

readString in interface ReadableRoot

Returns:

the read content

Throws:

IOException - upon failure to open

openReader

public <R> R openReader(@NonNull DataRoot.Operation<R,@NonNull Reader> operation)
                 throws IOException

Description copied from interface: ReadableRoot

Opens a reader to the data

Specified by:

openReader in interface ReadableRoot

Type Parameters:

R - the result type

Parameters:

operation - the operation

Returns:

the operation result

Throws:

IOException - upon failure to open

writeString

public void writeString(@NonNull String content)
                 throws IOException

Description copied from interface: ReadableRoot

Writes to a string

Specified by:

writeString in interface ReadableRoot

Parameters:

content - the content to write

Throws:

IOException - upon failure to write

openWriter

public <R> R openWriter(@NonNull DataRoot.Operation<R,@NonNull Writer> operation)
                 throws IOException

Description copied from interface: ReadableRoot

Opens a writer for the data

Specified by:

openWriter in interface ReadableRoot

Type Parameters:

R - the result type

Parameters:

operation - the operation

Returns:

the operation result

Throws:

IOException - upon failure to open

openReadChannel

public <R> R openReadChannel(@NonNull DataRoot.Operation<R,@NonNull ReadableByteChannel> operation)
                      throws IOException

Description copied from interface: BinaryRoot

Opens a read channel for the data

Specified by:

openReadChannel in interface BinaryRoot

Type Parameters:

R - the result type

Parameters:

operation - the operation

Returns:

the operation result

Throws:

IOException - upon failure to open

openInputStream

public <R> R openInputStream(@NonNull DataRoot.Operation<R,@NonNull InputStream> operation)
                      throws IOException

Description copied from interface: BinaryRoot

Opens an input stream for the data

Specified by:

openInputStream in interface BinaryRoot

Type Parameters:

R - the result type

Parameters:

operation - the operation

Returns:

the operation result

Throws:

IOException - upon failure to open

openWriteChannel

public <R> R openWriteChannel(@NonNull DataRoot.Operation<R,@NonNull WritableByteChannel> operation)
                       throws IOException

Description copied from interface: BinaryRoot

Opens a write channel to the data

Specified by:

openWriteChannel in interface BinaryRoot

Type Parameters:

R - the result type

Parameters:

operation - the operation

Returns:

the operation result

Throws:

IOException - upon failure to open

openOutputStream

public <R> R openOutputStream(@NonNull DataRoot.Operation<R,@NonNull OutputStream> operation)
                       throws IOException

Description copied from interface: BinaryRoot

Opens an output stream to the data

Specified by:

openOutputStream in interface BinaryRoot

Type Parameters:

R - the result type

Parameters:

operation - the operation

Returns:

the operation result

Throws:

IOException - upon failure to open