com.asakusafw.utils.gradle

Class Bundle

java.lang.Object

com.asakusafw.utils.gradle.Bundle

public class Bundle
extends Object

Represents a file bundle that have a single root directory.

Since:

0.9.2

Constructor Summary

Constructors

Constructor and Description
Bundle(ProjectContext context, Path root) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Bundle	clean() Removes all files on this bundle excepts the content root directory.
Bundle	clean(String path) Removes target resource on the bundle only if it exists.
Bundle	copy(Path source) Copies files from the given directory into bundle root.
Bundle	copy(Path source, String onto) Copies files from the given file or directory onto the path.
Bundle	extract(Path source) Copies files from the given file or directory into bundle root.
Bundle	extract(Path source, String onto) Copies files from the given file or directory onto the path.
Optional<Path>	find(String path) Returns a file on this bundle.
Bundle	find(String path, TryConsumer<? super Path,IOException> configurator) Returns a file on this bundle.
Path	get(String path) Returns a file on the bundle.
Bundle	get(String path, TryConsumer<? super Path,IOException> configurator) Process a file on the bundle.
Path	getDirectory() Returns the bundle directory.
int	launch(String command, String... arguments) Launches the command.
Path	put(String path) Creates a file.
Bundle	put(String path, TryConsumer<? super Path,IOException> configurator) Creates a file.
Bundle	withLaunch(String command, String... arguments) Launches the command, or raise exception if the command failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bundle

public Bundle(ProjectContext context,
              Path root)

Creates a new instance.

Parameters:

context - the current context

root - the bundle root directory

Method Detail

getDirectory

public Path getDirectory()

Returns the bundle directory.

Returns:

the bundle directory

copy

public Bundle copy(Path source)

Copies files from the given directory into bundle root.

Parameters:

source - the source directory

Returns:

this

See Also:

Paths.get(String, String...)

copy

public Bundle copy(Path source,
                   String onto)

Copies files from the given file or directory onto the path.

Parameters:

source - the source file or directory

onto - the copy target path (relative from the bundle root)

Returns:

this

See Also:

Paths.get(String, String...)

extract

public Bundle extract(Path source)

Copies files from the given file or directory into bundle root. This accepts paths in archive files, like /path/to/file.jar/META-INF. It extracts only under META-INF in /path/to/file.jar.

Parameters:

source - the source file or directory

Returns:

this

See Also:

Paths.get(String, String...)

extract

public Bundle extract(Path source,
                      String onto)

Copies files from the given file or directory onto the path.

Parameters:

source - the source file or directory

onto - the copy target path (relative from the bundle root)

Returns:

this

See Also:

Paths.get(String, String...)

clean

public Bundle clean()

Removes all files on this bundle excepts the content root directory.

Returns:

this

clean

public Bundle clean(String path)

Removes target resource on the bundle only if it exists. If there is no such a resource on this bundle, this method will do nothing.

Parameters:

path - the target path

Returns:

this

find

public Optional<Path> find(String path)

Returns a file on this bundle.

Parameters:

path - the relative path from the bundle root

Returns:

the file, or empty if it is not found

get

public Path get(String path)

Returns a file on the bundle.

Parameters:

path - the relative path from the bundle root

Returns:

the file, or empty if it is not found

put

public Path put(String path)

Creates a file.

Parameters:

path - the relative path from the bundle root

Returns:

the created file

find

public Bundle find(String path,
                   TryConsumer<? super Path,IOException> configurator)

Returns a file on this bundle.

Parameters:

path - the relative path from the bundle root

configurator - the configurator, which will be invoked only if the file exists

Returns:

the file, or empty if it is not found

get

public Bundle get(String path,
                  TryConsumer<? super Path,IOException> configurator)

Process a file on the bundle.

Parameters:

path - the relative path from the bundle root

configurator - the file configurator

Returns:

this

put

public Bundle put(String path,
                  TryConsumer<? super Path,IOException> configurator)

Creates a file.

Parameters:

path - the relative path from the bundle root

configurator - consumes the created file

Returns:

this

launch

public int launch(String command,
                  String... arguments)

Launches the command.

Parameters:

command - the command, relative from bundle root

arguments - the command arguments

Returns:

the exit status

See Also:

BasicCommandLauncher

withLaunch

public Bundle withLaunch(String command,
                         String... arguments)

Launches the command, or raise exception if the command failed.

Parameters:

command - the command, relative from bundle root

arguments - the command arguments

Returns:

this

See Also:

BasicCommandLauncher