com.asakusafw.runtime.core

Class BatchContext

java.lang.Object

com.asakusafw.runtime.core.BatchContext

public final class BatchContext
extends Object

Context API entry class. The context API provides the batch arguments and others about the current batch execution. Clients can use this class only in operator methods, not in flow, importer, nor descriptions.

Since:

0.1.0

Version:

0.9.0

Method Summary

Modifier and Type	Method and Description
static String	get(String name) Returns a value of the context variable (which includes batch arguments).
static ApiStub<BatchContextApi>	getStub() Returns the API stub.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static String get(String name)

Returns a value of the context variable (which includes batch arguments).

Parameters:

name - the target variable name

Returns:

the value of the target variable, or null if it is not defined in this context

Throws:

IllegalArgumentException - if the parameter is null

getStub

public static ApiStub<BatchContextApi> getStub()

Returns the API stub. Application developer must not use this directly.

Returns:

the API stub

Since:

0.9.0