org.macroing.builder

Class Script

java.lang.Object

org.macroing.builder.Script

public abstract class Script
extends java.lang.Object

The Script class is mainly used as an extension point for functionality that are, or are supposed to be, a part of the core program itself.

As this project matures, other extension point mechanisms are likely to be added in the future.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Script() Constructs a new Script instance.

Method Summary

Modifier and Type	Method and Description
static void	copy(java.io.File file, java.io.File directory) Copies file to directory.
static void	copy(java.io.File file, java.io.OutputStream outputStream) Copies file to outputStream.
static void	copy(java.io.InputStream inputStream, java.io.File file) Copies the data from inputStream to file.
static void	copy(java.io.InputStream inputStream, java.io.OutputStream outputStream) Copies the data from inputStream to outputStream.
static boolean	delete(java.io.File file) Deletes the file or directory denoted by the abstract pathname provided by file.
static boolean	delete(java.lang.String pathname) Deletes the file or directory denoted by the abstract pathname provided by pathname.
static java.util.List<java.io.File>	empty(java.io.File directory) Returns a List with the Files that were deleted, as a result of emptying directory.
static java.util.List<java.io.File>	empty(java.lang.String directoryPath) Returns a List with the Files that were deleted, as a result of emptying the directory given by directoryPath.
static java.util.List<java.io.File>	getDirectoriesFromDirectory(java.io.File root) Adds all Files that are direct or indirect children to root and file.isDirectory() returns true, to a List, starting from root.
static java.util.List<java.io.File>	getDirectoriesFromDirectory(java.io.File root, java.util.List<java.io.File> directories) Adds all Files that are direct or indirect children to root and file.isDirectory() returns true, to directories, starting from root.
static java.util.List<java.io.File>	getFilesFromDirectory(java.io.File root) Adds all Files that are direct or indirect children to root and file.isFile() returns true, to a List, starting from root.
static java.util.List<java.io.File>	getFilesFromDirectory(java.io.File root, java.util.List<java.io.File> files) Adds all Files that are direct or indirect children to root and file.isFile() returns true, to files, starting from root.
static java.util.List<java.io.File>	getFilesFromDirectory(java.lang.String root) Adds all Files that are direct or indirect children to root and file.isFile() returns true, to a List, starting from root.
static boolean	javac(java.io.File classOutput, java.io.File[] classPath, java.io.File[] sourcePath, java.io.File[] sourceFiles)
static boolean	javac(java.io.File classOutput, java.util.List<java.io.File> classPath, java.util.List<java.io.File> sourcePath, java.util.List<java.io.File> sourceFiles)
static boolean	javac(java.lang.String classOutput, java.util.List<java.io.File> classPath, java.util.List<java.io.File> sourcePath, java.util.List<java.io.File> sourceFiles)
static boolean	javac(java.lang.String classOutput, java.lang.String[] classPath, java.lang.String[] sourcePath, java.lang.String[] sourceFiles)
static boolean	mkdir(java.io.File directory) Creates the directory named by the abstract pathname provided by directory.
static boolean	mkdir(java.lang.String directoryPath) Creates the directory named by the abstract pathname provided by directoryPath.
static boolean	mkdirs(java.io.File directory) Creates the directory named by the abstract pathname provided by directory, including any necessary but nonexistent parent directories.
static boolean	mkdirs(java.lang.String directoryPath) Creates the directory named by the abstract pathname provided by directoryPath, including any necessary but nonexistent parent directories.
static void	unzip(java.io.File file, java.io.File directory) Unzips file to directory.
static void	zip(java.io.File directory, java.io.File file) Zips directory to file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Script

protected Script()

Constructs a new Script instance.

Method Detail

delete

public static boolean delete(java.io.File file)

Deletes the file or directory denoted by the abstract pathname provided by file.

Returns true if, and only if, the file or directory was deleted, false otherwise.

If file is null, a NullPointerException will be thrown.

Parameters:

file - a File

Returns:

true if, and only if, the file or directory was deleted, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, file is null

delete

public static boolean delete(java.lang.String pathname)

Deletes the file or directory denoted by the abstract pathname provided by pathname.

Returns true if, and only if, the file or directory was deleted, false otherwise.

If pathname is null, a NullPointerException will be thrown.

Parameters:

pathname - a String with the abstract pathname

Returns:

true if, and only if, the file or directory was deleted, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, pathname is null

javac

public static boolean javac(java.io.File classOutput,
                            java.io.File[] classPath,
                            java.io.File[] sourcePath,
                            java.io.File[] sourceFiles)
                     throws java.io.IOException

Throws:

java.io.IOException

javac

public static boolean javac(java.io.File classOutput,
                            java.util.List<java.io.File> classPath,
                            java.util.List<java.io.File> sourcePath,
                            java.util.List<java.io.File> sourceFiles)
                     throws java.io.IOException

Throws:

java.io.IOException

javac

public static boolean javac(java.lang.String classOutput,
                            java.util.List<java.io.File> classPath,
                            java.util.List<java.io.File> sourcePath,
                            java.util.List<java.io.File> sourceFiles)
                     throws java.io.IOException

Throws:

java.io.IOException

javac

public static boolean javac(java.lang.String classOutput,
                            java.lang.String[] classPath,
                            java.lang.String[] sourcePath,
                            java.lang.String[] sourceFiles)
                     throws java.io.IOException

Throws:

java.io.IOException

mkdir

public static boolean mkdir(java.io.File directory)

Creates the directory named by the abstract pathname provided by directory.

Returns true if, and only if, the directory was created, false otherwise.

If directory is null, a NullPointerException will be thrown.

Parameters:

directory - a File

Returns:

true if, and only if, the directory was created, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, directory is null

mkdir

public static boolean mkdir(java.lang.String directoryPath)

Creates the directory named by the abstract pathname provided by directoryPath.

Returns true if, and only if, the directory was created, false otherwise.

If directoryPath is null, a NullPointerException will be thrown.

Parameters:

directoryPath - a String with the abstract pathname

Returns:

true if, and only if, the directory was created, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, directoryPath is null

mkdirs

public static boolean mkdirs(java.io.File directory)

Creates the directory named by the abstract pathname provided by directory, including any necessary but nonexistent parent directories.

Returns true if, and only if, the directory was created, along with all necessary parent directories, false otherwise.

If directory is null, a NullPointerException will be thrown.

Parameters:

directory - a File

Returns:

true if, and only if, the directory was created, along with all necessary parent directories, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, directory is null

mkdirs

public static boolean mkdirs(java.lang.String directoryPath)

Creates the directory named by the abstract pathname provided by directoryPath, including any necessary but nonexistent parent directories.

Returns true if, and only if, the directory was created, along with all necessary parent directories, false otherwise.

If directoryPath is null, a NullPointerException will be thrown.

Parameters:

directoryPath - a String with the abstract pathname

Returns:

true if, and only if, the directory was created, along with all necessary parent directories, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, directoryPath is null

empty

public static java.util.List<java.io.File> empty(java.io.File directory)
                                          throws java.io.IOException

Returns a List with the Files that were deleted, as a result of emptying directory.

If directory is null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

directory - the directory to empty

Returns:

a List with the Files that were deleted, as a result of emptying directory

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, directory is null

empty

public static java.util.List<java.io.File> empty(java.lang.String directoryPath)
                                          throws java.io.IOException

Returns a List with the Files that were deleted, as a result of emptying the directory given by directoryPath.

If directoryPath is null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

directoryPath - the path to the directory to empty

Returns:

a List with the Files that were deleted, as a result of emptying the directory given by directoryPath

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, directoryPath is null

getDirectoriesFromDirectory

public static java.util.List<java.io.File> getDirectoriesFromDirectory(java.io.File root)

Adds all Files that are direct or indirect children to root and file.isDirectory() returns true, to a List, starting from root.

Returns a List of Files denoting directories.

Calling this method is equivalent to calling getDirectoriesFromDirectory(root, new ArrayList<>()).

If root is null, a NullPointerException will be thrown.

If root.isDirectory() returns false, an empty List will be returned.

Parameters:

root - the root directory

Returns:

a List of Files denoting directories

Throws:

java.lang.NullPointerException - thrown if, and only if, root is null

getDirectoriesFromDirectory

public static java.util.List<java.io.File> getDirectoriesFromDirectory(java.io.File root,
                                                                       java.util.List<java.io.File> directories)

Adds all Files that are direct or indirect children to root and file.isDirectory() returns true, to directories, starting from root.

Returns directories.

If either root or directories are null, a NullPointerException will be thrown.

If root.isDirectory() returns false, directories will be returned, in its initial state.

Parameters:

root - the root directory

directories - the List to add to and return

Returns:

directories

Throws:

java.lang.NullPointerException - thrown if, and only if, either root or directories are null

getFilesFromDirectory

public static java.util.List<java.io.File> getFilesFromDirectory(java.io.File root)

Adds all Files that are direct or indirect children to root and file.isFile() returns true, to a List, starting from root.

Returns a List of Files denoting files.

Calling this method is equivalent to calling getFilesFromDirectory(root, new ArrayList<>()).

If root is null, a NullPointerException will be thrown.

If root.isDirectory() returns false, an empty List will be returned.

Parameters:

root - the root directory

Returns:

a List of Files denoting files

Throws:

java.lang.NullPointerException - thrown if, and only if, root is null

getFilesFromDirectory

public static java.util.List<java.io.File> getFilesFromDirectory(java.io.File root,
                                                                 java.util.List<java.io.File> files)

Adds all Files that are direct or indirect children to root and file.isFile() returns true, to files, starting from root.

Returns files.

If either root or files are null, a NullPointerException will be thrown.

If root.isDirectory() returns false, files will be returned, in its initial state.

Parameters:

root - the root directory

files - the List to add to and return

Returns:

files

Throws:

java.lang.NullPointerException - thrown if, and only if, either root or files are null

getFilesFromDirectory

public static java.util.List<java.io.File> getFilesFromDirectory(java.lang.String root)

Adds all Files that are direct or indirect children to root and file.isFile() returns true, to a List, starting from root.

Returns a List of Files denoting files.

Calling this method is equivalent to calling getFilesFromDirectory(new File(root), new ArrayList<>()).

If root is null, a NullPointerException will be thrown.

If new File(root).isDirectory() returns false, an empty List will be returned.

Parameters:

root - the root directory

Returns:

a List of Files denoting files

Throws:

java.lang.NullPointerException - thrown if, and only if, root is null

copy

public static void copy(java.io.File file,
                        java.io.File directory)
                 throws java.io.IOException

Copies file to directory.

If either file or directory are null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

file - the file to copy

directory - the directory to copy the file to

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, either file or directory are null

copy

public static void copy(java.io.File file,
                        java.io.OutputStream outputStream)
                 throws java.io.IOException

Copies file to outputStream.

If either file or outputStream are null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

file - the file to copy

outputStream - the OutputStream to copy the file to

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, either file or outputStream are null

copy

public static void copy(java.io.InputStream inputStream,
                        java.io.File file)
                 throws java.io.IOException

Copies the data from inputStream to file.

If either inputStream or file are null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

inputStream - the InputStream to read the data to be copied from

file - the file to copy to

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, either inputStream or file are null

copy

public static void copy(java.io.InputStream inputStream,
                        java.io.OutputStream outputStream)
                 throws java.io.IOException

Copies the data from inputStream to outputStream.

If either inputStream or outputStream are null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

inputStream - the InputStream to read the data to be copied from

outputStream - the OutputStream to copy the data to

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, either inputStream or outputStream are null

unzip

public static void unzip(java.io.File file,
                         java.io.File directory)
                  throws java.io.IOException

Unzips file to directory.

If either file or directory are null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

file - the file to unzip

directory - the directory to unzip the file to

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, either file or directory are null

zip

public static void zip(java.io.File directory,
                       java.io.File file)
                throws java.io.IOException

Zips directory to file.

If either directory or file are null, a NullPointerException will be thrown.

If some I/O-related error occurs, an IOException will be thrown.

Parameters:

directory - the directory to zip

file - the file to zip the directory to

Throws:

java.io.IOException - thrown if, and only if, some I/O-related error occurs

java.lang.NullPointerException - thrown if, and only if, either directory or file are null