com.asakusafw.info.cli.common

Class BatchInfoParameter

java.lang.Object

com.asakusafw.info.cli.common.BatchInfoParameter

public class BatchInfoParameter
extends Object

Provides the batch information.

Since:

0.10.0

Field Summary

Fields

Modifier and Type	Field and Description
ApplicationBaseDirectoryParameter	batchappsParameter The batch application base directory.
String	location The information file location - must be one of batch ID, batch directory, or information file path.

Constructor Summary

Constructors

Constructor and Description
BatchInfoParameter()

Method Summary

Modifier and Type	Method and Description
static Optional<Path>	findInfo(Path applicationBaseDir, String location) Returns the DSL information file path.
Path	getPath() Returns the information file path.
BatchInfo	load() Loads the given information file.
static BatchInfo	load(Path path) Loads the given information file.

Methods inherited from class java.lang.Object

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

Field Detail

batchappsParameter

public final ApplicationBaseDirectoryParameter batchappsParameter

The batch application base directory.

location

public String location

The information file location - must be one of batch ID, batch directory, or information file path.

Constructor Detail

BatchInfoParameter

public BatchInfoParameter()

Method Detail

getPath

public Path getPath()

Returns the information file path.

Returns:

the information file path

Throws:

CommandConfigurationException - if it is not found

load

public BatchInfo load()

Loads the given information file.

Returns:

the loaded information

Throws:

CommandConfigurationException - if error occurred while loading the information file

findInfo

public static Optional<Path> findInfo(Path applicationBaseDir,
                                      String location)

Returns the DSL information file path.

Parameters:

applicationBaseDir - the batch application base directory (nullable)

location - the file location - must be one of batch ID, batch directory, or information file path

Returns:

the information file path, or empty if it is not found

load

public static BatchInfo load(Path path)

Loads the given information file.

Parameters:

path - the target information file path

Returns:

the loaded information

Throws:

CommandConfigurationException - if error occurred while loading the information file