org.springframework.batch.item
Class ExecutionContext

java.lang.Object
  extended by org.springframework.batch.item.ExecutionContext
All Implemented Interfaces:
Serializable

public class ExecutionContext
extends Object
implements Serializable

Object representing a context for an ItemStream. It is a thin wrapper for a map that allows optionally for type safety on reads. It also allows for dirty checking by setting a 'dirty' flag whenever any put is called.

Author:
Lucas Ward, Douglas Kaminsky
See Also:
Serialized Form

Constructor Summary
ExecutionContext()
          Default constructor.
ExecutionContext(ExecutionContext executionContext)
           
ExecutionContext(Map map)
          Initializes a new execution context with the contents of another map.
 
Method Summary
 void clearDirtyFlag()
          Clears the dirty flag.
 boolean containsKey(String key)
          Indicates whether or not a key is represented in this context.
 boolean containsValue(Object value)
          Indicates whether or not a value is represented in this context.
 Set entrySet()
          Returns the entry set containing the contents of this context.
 boolean equals(Object obj)
           
 Object get(String key)
          Getter for the value represented by the provided key.
 double getDouble(String key)
          Typesafe Getter for the Double represented by the provided key.
 double getDouble(String key, double defaultDouble)
          Typesafe Getter for the Double represented by the provided key with default value to return if key is not represented.
 long getLong(String key)
          Typesafe Getter for the Long represented by the provided key.
 long getLong(String key, long defaultLong)
          Typesafe Getter for the Long represented by the provided key with default value to return if key is not represented.
 Properties getProperties()
          Deprecated. to be removed with no replacement in 2.0. Should not be part of public API (test purposes only)
 String getString(String key)
          Typesafe Getter for the String represented by the provided key.
 String getString(String key, String defaultString)
          Typesafe Getter for the String represented by the provided key with default value to return if key is not represented.
 int hashCode()
           
 boolean isDirty()
          Indicates if context has been changed with a "put" operation since the dirty flag was last cleared.
 boolean isEmpty()
          Indicates whether or not the context is empty.
 void put(String key, Object value)
          Add an Object value to the context (must be Serializable).
 void putDouble(String key, double value)
          Add a Double value to the context.
 void putLong(String key, long value)
          Adds a Long value to the context.
 void putString(String key, String value)
          Adds a String value to the context.
 int size()
          Returns number of entries in the context
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExecutionContext

public ExecutionContext()
Default constructor. Initializes a new execution context with an empty internal map.


ExecutionContext

public ExecutionContext(Map map)
Initializes a new execution context with the contents of another map.

Parameters:
map - Initial contents of context.

ExecutionContext

public ExecutionContext(ExecutionContext executionContext)
Parameters:
executionContext -
Method Detail

putString

public void putString(String key,
                      String value)
Adds a String value to the context.

Parameters:
key - Key to add to context
value - Value to associate with key

putLong

public void putLong(String key,
                    long value)
Adds a Long value to the context.

Parameters:
key - Key to add to context
value - Value to associate with key

putDouble

public void putDouble(String key,
                      double value)
Add a Double value to the context.

Parameters:
key - Key to add to context
value - Value to associate with key

put

public void put(String key,
                Object value)
Add an Object value to the context (must be Serializable).

Parameters:
key - Key to add to context
value - Value to associate with key

isDirty

public boolean isDirty()
Indicates if context has been changed with a "put" operation since the dirty flag was last cleared. Note that the last time the flag was cleared might correspond to creation of the context.

Returns:
True if "put" operation has occurred since flag was last cleared

getString

public String getString(String key)
Typesafe Getter for the String represented by the provided key.

Parameters:
key - The key to get a value for
Returns:
The String value

getString

public String getString(String key,
                        String defaultString)
Typesafe Getter for the String represented by the provided key with default value to return if key is not represented.

Parameters:
key - The key to get a value for
defaultString - Default to return if key is not represented
Returns:
The String value if key is repreesnted, specified default otherwise

getLong

public long getLong(String key)
Typesafe Getter for the Long represented by the provided key.

Parameters:
key - The key to get a value for
Returns:
The Long value

getLong

public long getLong(String key,
                    long defaultLong)
Typesafe Getter for the Long represented by the provided key with default value to return if key is not represented.

Parameters:
key - The key to get a value for
defaultLong - Default to return if key is not represented
Returns:
The long value if key is represented, specified default otherwise

getDouble

public double getDouble(String key)
Typesafe Getter for the Double represented by the provided key.

Parameters:
key - The key to get a value for
Returns:
The Double value

getDouble

public double getDouble(String key,
                        double defaultDouble)
Typesafe Getter for the Double represented by the provided key with default value to return if key is not represented.

Parameters:
key - The key to get a value for
defaultDouble - Default to return if key is not represented
Returns:
The double value if key is represented, specified default otherwise

get

public Object get(String key)
Getter for the value represented by the provided key.

Parameters:
key - The key to get a value for
Returns:
The value represented by the given key

isEmpty

public boolean isEmpty()
Indicates whether or not the context is empty.

Returns:
True if the context has no entries, false otherwise.
See Also:
Map.isEmpty()

clearDirtyFlag

public void clearDirtyFlag()
Clears the dirty flag.


entrySet

public Set entrySet()
Returns the entry set containing the contents of this context.

Returns:
A set representing the contents of the context
See Also:
Map.entrySet()

containsKey

public boolean containsKey(String key)
Indicates whether or not a key is represented in this context.

Parameters:
key - Key to check existence for
Returns:
True if key is represented in context, false otherwise
See Also:
Map.containsKey(Object)

containsValue

public boolean containsValue(Object value)
Indicates whether or not a value is represented in this context.

Parameters:
value - Value to check existence for
Returns:
True if value is represented in context, false otherwise
See Also:
Map.containsValue(Object)

getProperties

public Properties getProperties()
Deprecated. to be removed with no replacement in 2.0. Should not be part of public API (test purposes only)

Returns a Properties object containing String versions of the contents of the context.

Returns:
Contents of context as a Properties

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object

size

public int size()
Returns number of entries in the context

Returns:
Number of entries in the context
See Also:
Map.size()


Copyright © 2009 SpringSource. All Rights Reserved.