Package org.springframework.batch.item

Class ItemStreamSupport

java.lang.Object

org.springframework.batch.item.ItemStreamSupport

All Implemented Interfaces:

ItemStream

Direct Known Subclasses:

AbstractItemStreamItemReader, AbstractItemStreamItemWriter, ChunkMonitor

public abstract class ItemStreamSupport
extends Object
implements ItemStream

Empty method implementation of ItemStream.

Author:

Dave Syer, Dean de Bree, Mahmoud Ben Hassine

Constructor Summary

Constructors

Constructor	Description
ItemStreamSupport()

Method Summary

Modifier and Type	Method	Description
void	close()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favor of ItemStream.close().
String	getExecutionContextKey(String key)
String	getName()	Get the name of the component
void	open(ExecutionContext executionContext)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favor of ItemStream.open(ExecutionContext) ()}.
protected void	setExecutionContextName(String name)
void	setName(String name)	The name of the component which will be used as a stem for keys in the ExecutionContext.
void	update(ExecutionContext executionContext)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favor of ItemStream.update(ExecutionContext) ()}.

Methods inherited from class java.lang.Object

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

Constructor Details

ItemStreamSupport

public ItemStreamSupport()

Method Details

close

@Deprecated(since="5.0",
            forRemoval=true)
public void close()

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.0 in favor of ItemStream.close(). Scheduled for removal in 5.2.

No-op.

Specified by:

close in interface ItemStream

See Also:

• ItemStream.close()

open

@Deprecated(since="5.0",
            forRemoval=true)
public void open(ExecutionContext executionContext)

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.0 in favor of ItemStream.open(ExecutionContext) ()}. Scheduled for removal in 5.2.

No-op.

Specified by:

open in interface ItemStream

Parameters:

executionContext - current step's ExecutionContext. Will be the executionContext from the last run of the step on a restart.

See Also:

• ItemStream.open(ExecutionContext)

update

@Deprecated(since="5.0",
            forRemoval=true)
public void update(ExecutionContext executionContext)

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.0 in favor of ItemStream.update(ExecutionContext) ()}. Scheduled for removal in 5.2.

Return empty ExecutionContext.

Specified by:

update in interface ItemStream

Parameters:

executionContext - to be updated

See Also:

• ItemStream.update(ExecutionContext)

setName

public void setName(String name)

The name of the component which will be used as a stem for keys in the ExecutionContext. Subclasses should provide a default value, e.g. the short form of the class name.

Parameters:

name - the name for the component

getName

public String getName()

Get the name of the component

Returns:

the name of the component

setExecutionContextName

protected void setExecutionContextName(String name)

getExecutionContextKey

public String getExecutionContextKey(String key)