Package com.atlassian.bamboo.file

Class SafeFileFactory

java.lang.Object

com.atlassian.bamboo.file.SafeFileOperationFactory<File>

com.atlassian.bamboo.file.SafeFileFactory

public final class SafeFileFactory
extends SafeFileOperationFactory<File>

Factory class for creating File instances. This should be the only way to create a File object.

Since:

12.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.bamboo.file.SafeFileOperationFactory

SafeFileOperationFactory.NoValidationReason

Method Summary

Modifier and Type	Method	Description
File	get()
static SafeFileFactory	lenient(File parent, @NotNull String child)
static SafeFileFactory	lenient(String parent, @NotNull String child)
static SafeFileFactory	of(File parent, @NotNull String child)
static SafeFileFactory	of(String path)
static SafeFileFactory	of(String parent, @NotNull String child)
static SafeFileFactory	of(URI uri)
static SafeFileFactory	strict(File parent, @NotNull String child)
protected String	toPath()	Returns the path to the file.

Methods inherited from class com.atlassian.bamboo.file.SafeFileOperationFactory

create, createWithoutValidation, withSecureDirectory, withSecureDirectory, withSecureDirectory

Methods inherited from class java.lang.Object

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

Method Details

of

public static SafeFileFactory of(String path)

of

public static SafeFileFactory of(URI uri)

of

public static SafeFileFactory of(String parent,
 @NotNull
 @NotNull String child)

lenient

public static SafeFileFactory lenient(String parent,
 @NotNull
 @NotNull String child)

of

public static SafeFileFactory of(File parent,
 @NotNull
 @NotNull String child)

lenient

public static SafeFileFactory lenient(File parent,
 @NotNull
 @NotNull String child)

strict

public static SafeFileFactory strict(File parent,
 @NotNull
 @NotNull String child)

toPath

protected String toPath()

Description copied from class: SafeFileOperationFactory

Returns the path to the file. This should be the file to which the file operator give the access. e.g. for java.io.File it would be java.io.File#getPath()

Specified by:

toPath in class SafeFileOperationFactory<File>

Returns:

the path as a string

get

public File get()

Specified by:

get in class SafeFileOperationFactory<File>