RuntimeContext (Asakusa Framework 0.10.4 API)

java.lang.Object
- com.asakusafw.runtime.core.context.RuntimeContext

public final class RuntimeContext
extends Object

Holds runtime context information.

Since:: 0.4.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RuntimeContext.ExecutionMode
Represents execution type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RuntimeContext.ExecutionMode` Represents execution type.

Field Summary

Fields
Modifier and Type	Field and Description
`static RuntimeContext`	`DEFAULT` Default context.
`static String`	`KEY_BATCH_ID` The value map key of `batchId(String)`.
`static String`	`KEY_BUILD_DATE` The value map key of build date.
`static String`	`KEY_BUILD_ID` The value map key of `buildId(String)`.
`static String`	`KEY_EXECUTION_MODE` The value map key of `mode(ExecutionMode)`.
`static String`	`KEY_FLOW_ID` The value map key of flow ID.
`static String`	`KEY_RUNTIME_VERSION` The value map key of `runtime version`.
`static String`	`PATH_APPLICATION_INFO` The relative path from classpath of application info.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuntimeContext`	`apply(Map<String,String> newValueMap)` Creates an inherited context from a value map.
`RuntimeContext`	`batchId(String newValue)` Creates an inherited context with specified batch ID.
`RuntimeContext`	`buildId(String newValue)` Creates an inherited context with specified verification code.
`boolean`	`canExecute(Object object)` Returns whether target object is executable in current execution mode.
`boolean`	`equals(Object obj)`
`static RuntimeContext`	`get()` Returns the global context.
`static String`	`getRuntimeVersion()` Returns the current runtime version.
`int`	`hashCode()`
`boolean`	`isSimulation()` Returns whether this execution is in simulation mode.
`RuntimeContext`	`mode(RuntimeContext.ExecutionMode newValue)` Creates an inherited context with specified execution mode.
`static void`	`set(RuntimeContext context)` Replaces the global context.
`String`	`toString()`
`Map<String,String>`	`unapply()` Creates a value map that describes this context.
`void`	`verifyApplication(ClassLoader classLoader)` Verifies application by using current context.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT
```
public static final RuntimeContext DEFAULT
```
    Default context.
  - PATH_APPLICATION_INFO
```
public static final String PATH_APPLICATION_INFO
```
    The relative path from classpath of application info. This may includes following information.
    - batch ID (key=KEY_BATCH_ID)
    - flow ID (key=KEY_FLOW_ID)
    - build ID (key=KEY_BUILD_ID)
    See Also:
    
    Constant Field Values
  - KEY_EXECUTION_MODE
```
public static final String KEY_EXECUTION_MODE
```
    The value map key of mode(ExecutionMode).
    
    See Also:
    
    apply(Map), unapply(), Constant Field Values
  - KEY_BATCH_ID
```
public static final String KEY_BATCH_ID
```
    The value map key of batchId(String).
    
    See Also:
    
    apply(Map), unapply(), Constant Field Values
  - KEY_FLOW_ID
```
public static final String KEY_FLOW_ID
```
    The value map key of flow ID. This is only for information path.
    
    See Also:
    
    Constant Field Values
  - KEY_BUILD_ID
```
public static final String KEY_BUILD_ID
```
    The value map key of buildId(String).
    
    See Also:
    
    apply(Map), unapply(), Constant Field Values
  - KEY_BUILD_DATE
```
public static final String KEY_BUILD_DATE
```
    The value map key of build date.
    
    See Also:
    
    Constant Field Values
  - KEY_RUNTIME_VERSION
```
public static final String KEY_RUNTIME_VERSION
```
    The value map key of runtime version.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - get
```
public static RuntimeContext get()
```
    Returns the global context.
    
    Returns:
    
    the global context
  - set
```
public static void set(RuntimeContext context)
```
    Replaces the global context.
    
    Parameters:
    
    context - the replacement
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
  - getRuntimeVersion
```
public static String getRuntimeVersion()
```
    Returns the current runtime version.
    
    Returns:
    
    current runtime version
  - mode
```
public RuntimeContext mode(RuntimeContext.ExecutionMode newValue)
```
    Creates an inherited context with specified execution mode.
    
    Parameters:
    
    newValue - execution mode
    
    Returns:
    
    the inherited context
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
  - batchId
```
public RuntimeContext batchId(String newValue)
```
    Creates an inherited context with specified batch ID.
    
    Parameters:
    
    newValue - batch ID, or null to unset batch ID
    
    Returns:
    
    the inherited context
  - buildId
```
public RuntimeContext buildId(String newValue)
```
    Creates an inherited context with specified verification code.
    
    Parameters:
    
    newValue - verification code, or null to unset verification code
    
    Returns:
    
    the inherited context
  - apply
```
public RuntimeContext apply(Map<String,String> newValueMap)
```
    Creates an inherited context from a value map.
    
    Parameters:
    
    newValueMap - value map
    
    Returns:
    
    the inherited context
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
    
    See Also:
    
    KEY_BATCH_ID, KEY_EXECUTION_MODE, KEY_BUILD_ID
  - unapply
```
public Map<String,String> unapply()
```
    Creates a value map that describes this context.
    
    Returns:
    
    the value map
    
    See Also:
    
    apply(Map)
  - isSimulation
```
public boolean isSimulation()
```
    Returns whether this execution is in simulation mode.
    
    Returns:
    
    true if this execution is in simulation mode, otherwise false
  - canExecute
```
public boolean canExecute(Object object)
```
    Returns whether target object is executable in current execution mode.
    
    Parameters:
    
    object - target object
    
    Returns:
    
    true if is executable, otherwise false
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
  - verifyApplication
```
public void verifyApplication(ClassLoader classLoader)
```
    Verifies application by using current context.
    
    Parameters:
    
    classLoader - application classes
    
    Throws:
    
    InconsistentApplicationException - if failed to verify
    
    IllegalArgumentException - if some parameters were null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RuntimeContext

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

PATH_APPLICATION_INFO

KEY_EXECUTION_MODE

KEY_BATCH_ID

KEY_FLOW_ID

KEY_BUILD_ID

KEY_BUILD_DATE

KEY_RUNTIME_VERSION

Method Detail

get

set

getRuntimeVersion

mode

batchId

buildId

apply

unapply

isSimulation

canExecute

verifyApplication

hashCode

equals

toString