ratpack.test.embed

Class PathBaseDirBuilder

java.lang.Object

ratpack.test.embed.PathBaseDirBuilder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BaseDirBuilder

Direct Known Subclasses:

JarFileBaseDirBuilder

public class PathBaseDirBuilder
extends java.lang.Object
implements BaseDirBuilder

A BaseDirBuilder that is based on an initial Path.

Constructor Summary

Constructors

Constructor and Description
PathBaseDirBuilder(java.io.File baseDir) Constructor.
PathBaseDirBuilder(java.nio.file.Path baseDir) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.file.Path	build() Build the baseDir.
void	close() If the path backing this build is not from the default file system, its file system will be closed.
java.nio.file.Path	dir(java.lang.String path) Creates a directory at the given path within the base dir.
java.nio.file.Path	file(java.lang.String path) Returns a path for the given path within the base dir.
java.nio.file.Path	file(java.lang.String path, java.lang.String content) Creates a file with the given string content at the given path within the base dir.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathBaseDirBuilder

public PathBaseDirBuilder(java.io.File baseDir)

Constructor.

Parameters:

baseDir - used to call this(baseDir.toPath())

PathBaseDirBuilder

public PathBaseDirBuilder(java.nio.file.Path baseDir)

Constructor.

Parameters:

baseDir - The base dir for this builder (will be returned by build()

Method Detail

file

public java.nio.file.Path file(java.lang.String path)

Returns a path for the given path within the base dir.

All parent directories will be created on demand.

Specified by:

file in interface BaseDirBuilder

Parameters:

path - The relative path to the path

file

public java.nio.file.Path file(java.lang.String path,
                      java.lang.String content)

Creates a file with the given string content at the given path within the base dir.

All parent directories will be created on demand.

Specified by:

file in interface BaseDirBuilder

Parameters:

path - The relative path to the file to create

content - The content to write to the file

dir

public java.nio.file.Path dir(java.lang.String path)

Creates a directory at the given path within the base dir.

All parent directories will be created on demand.

Specified by:

dir in interface BaseDirBuilder

Parameters:

path - The relative path to the file to create

close

public void close()
           throws java.io.IOException

If the path backing this build is not from the default file system, its file system will be closed.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - If the build could not be closed cleanly

build

public java.nio.file.Path build()

Build the baseDir.

Specified by:

build in interface BaseDirBuilder

Returns:

The base dir