org.verapdf.core.utils

Class FileOutputMappers

java.lang.Object

org.verapdf.core.utils.FileOutputMappers

public class FileOutputMappers
extends Object

Factory for various kinds of FileOutputMapper.

Version:

0.1 Created 13 Nov 2016:14:07:32

Author:

Carl Wilson carlwilson AT github

Method Summary

Modifier and Type	Method and Description
static FileOutputMapper	fold(String path)
static FileOutputMapper	fold(String path, String prefix)
static FileOutputMapper	fold(String path, String prefix, String suffix) Maps to a relative subfolder of the original with no prefix or suffix
static FileOutputMapper	sibFiles() Get a FileOutputMapper instance that maps output to the same directory as the source with a veraPDF_ prefix
static FileOutputMapper	sibFiles(String prefix) Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix
static FileOutputMapper	sibFiles(String prefix, String suffix) Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix and suffix
static FileOutputMapper	subFold(String relativePath) Maps to a relative subfolder of the original with no prefix or suffix
static FileOutputMapper	subFold(String relativePath, String prefix) Maps to a relative subfolder of the original with no prefix or suffix
static FileOutputMapper	subFold(String relativePath, String prefix, String suffix) Maps to a relative subfolder of the original with no prefix or suffix
static FileOutputMapper	toRelativeDest(Path src, Path dest)
static FileOutputMapper	toRelativeDest(Path src, Path dest, String prefix)
static FileOutputMapper	toRelativeDest(Path src, Path dest, String prefix, String suffix)
static FileOutputMapper	verFold(String path)
static FileOutputMapper	verFold(String path, String prefix)
static FileOutputMapper	verFold(String path, String prefix, String suffix) Maps to a relative subfolder of the original with no prefix or suffix
static FileOutputMapper	verSibFiles() Get a FileOutputMapper instance that maps output to the same directory as the source with a veraPDF_ prefix
static FileOutputMapper	verSibFiles(String prefix) Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix
static FileOutputMapper	verSibFiles(String prefix, String suffix) Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix and suffix
static FileOutputMapper	verSubFold(String relativePath) Maps to a relative subfolder of the original with no prefix or suffix
static FileOutputMapper	verSubFold(String relativePath, String prefix) Maps to a relative subfolder of the original with no prefix or suffix
static FileOutputMapper	verSubFold(String relativePath, String prefix, String suffix) Maps to a relative subfolder of the original with no prefix or suffix

Methods inherited from class java.lang.Object

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

Method Detail

sibFiles

public static final FileOutputMapper sibFiles()

Get a FileOutputMapper instance that maps output to the same directory as the source with a veraPDF_ prefix

Returns:

a new FileOutputMapper

verSibFiles

public static final FileOutputMapper verSibFiles()

Get a FileOutputMapper instance that maps output to the same directory as the source with a veraPDF_ prefix

Returns:

a new FileOutputMapper

sibFiles

public static final FileOutputMapper sibFiles(String prefix)

Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix

Parameters:

prefix - the requested prefix, can not be null or empty

Returns:

a new FileOutputMapper

verSibFiles

public static final FileOutputMapper verSibFiles(String prefix)

Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix

Parameters:

prefix - the requested prefix, can not be null or empty

Returns:

a new FileOutputMapper

sibFiles

public static final FileOutputMapper sibFiles(String prefix,
                                              String suffix)

Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix and suffix

Parameters:

prefix - the prefix for generated files, can not be null or empty

suffix - the suffix for generated files, can not be null

Returns:

a new FileOutputMapper

verSibFiles

public static final FileOutputMapper verSibFiles(String prefix,
                                                 String suffix)

Get a FileOutputMapper instance that maps output to the same directory as the source with the requested prefix and suffix

Parameters:

prefix - the prefix for generated files, can not be null or empty

suffix - the suffix for generated files, can not be null

Returns:

a new FileOutputMapper

subFold

public static final FileOutputMapper subFold(String relativePath)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location, can not be null or empty

Returns:

a new FileOutputMapper

verSubFold

public static final FileOutputMapper verSubFold(String relativePath)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location, can not be null or empty

Returns:

a new FileOutputMapper

subFold

public static final FileOutputMapper subFold(String relativePath,
                                             String prefix)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location

prefix - the prefix for generated files, can not be null or empty

Returns:

a new FileOutputMapper

verSubFold

public static final FileOutputMapper verSubFold(String relativePath,
                                                String prefix)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location

prefix - the prefix for generated files, can not be null or empty

Returns:

a new FileOutputMapper

subFold

public static final FileOutputMapper subFold(String relativePath,
                                             String prefix,
                                             String suffix)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location

prefix - the prefix for generated files, can not be null or empty

Returns:

a new FileOutputMapper

verSubFold

public static final FileOutputMapper verSubFold(String relativePath,
                                                String prefix,
                                                String suffix)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location

prefix - the prefix for generated files, can not be null or empty

Returns:

a new FileOutputMapper

toRelativeDest

public static final FileOutputMapper toRelativeDest(Path src,
                                                    Path dest)

toRelativeDest

public static final FileOutputMapper toRelativeDest(Path src,
                                                    Path dest,
                                                    String prefix)

toRelativeDest

public static final FileOutputMapper toRelativeDest(Path src,
                                                    Path dest,
                                                    String prefix,
                                                    String suffix)

fold

public static final FileOutputMapper fold(String path)

verFold

public static final FileOutputMapper verFold(String path)

fold

public static final FileOutputMapper fold(String path,
                                          String prefix)

verFold

public static final FileOutputMapper verFold(String path,
                                             String prefix)

fold

public static final FileOutputMapper fold(String path,
                                          String prefix,
                                          String suffix)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location

prefix - the prefix for generated files, can not be null or empty

Returns:

a new FileOutputMapper

verFold

public static final FileOutputMapper verFold(String path,
                                             String prefix,
                                             String suffix)

Maps to a relative subfolder of the original with no prefix or suffix

Parameters:

relativePath - the relative path to the results folder from the original source file location

prefix - the prefix for generated files, can not be null or empty

Returns:

a new FileOutputMapper