C# Класс Summer.Batch.Core.Scope.Context.StepContext

A context object that can be used to interrogate the current StepExecution and some of its associated properties using expressions based on bean paths. Has public getters for the step execution and convenience methods for accessing commonly used properties like the ExecutionContext associated with the step or its enclosing job execution.

Наследование: Summer.Batch.Infrastructure.Repeat.Context.SynchronizedAttributeAccessor

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
Close ( ) : void	Clean up the context at the end of a step execution. Must be called once at the end of a step execution to honour the destruction callback contract from the Step Scope.
Equals ( object other ) : bool	Equals override.
GetHashCode ( ) : int	Overrides the default behaviour to provide a hash code based only on the step execution.
GetId ( ) : string
GetJobExecutionContext ( ) : object>.IReadOnlyDictionary	Returns the job execution context.
GetJobName ( ) : string	Convenient accessor for current job name identifier.
GetJobParameters ( ) : JobParameter>.IReadOnlyDictionary	Returns the job parameters.
GetStepExecutionContext ( ) : object>.IReadOnlyDictionary	Returns the step execution context.
GetStepName ( ) : string	Convenient accessor for current step name identifier. Usually this is the same as the bean name of the step that is executing (but might not be e.g. in a partition).
RegisterDestructionCallback ( string name, System.Threading.Tasks.Task callback ) : void	Allow clients to register callbacks for clean up on close.
RemoveAttribute ( string name ) : object	Override base class behaviour to ensure destruction callbacks are unregistered as well as the default behaviour.
StepContext ( StepExecution stepExecution ) : System	Create a new instance of StepContext for this StepExecution.
ToString ( ) : string	ToString override.

Приватные методы

Метод	Описание
UnregisterDestructionCallbacks ( string name ) : void	Unregisters destruction callback.

Описание методов

Close() публичный Метод

Clean up the context at the end of a step execution. Must be called once at the end of a step execution to honour the destruction callback contract from the Step Scope.

public Close ( ) : void
Результат	void

Equals() публичный Метод

Equals override.

public Equals ( object other ) : bool
other	object
Результат	bool

GetHashCode() публичный Метод

Overrides the default behaviour to provide a hash code based only on the step execution.

public GetHashCode ( ) : int
Результат	int

GetId() публичный Метод

public GetId ( ) : string
Результат	string

GetJobExecutionContext() публичный Метод

Returns the job execution context.

public GetJobExecutionContext ( ) : object>.IReadOnlyDictionary
Результат	object>.IReadOnlyDictionary

GetJobName() публичный Метод

Convenient accessor for current job name identifier.

public GetJobName ( ) : string
Результат	string

GetJobParameters() публичный Метод

Returns the job parameters.

public GetJobParameters ( ) : JobParameter>.IReadOnlyDictionary
Результат	JobParameter>.IReadOnlyDictionary

GetStepExecutionContext() публичный Метод

Returns the step execution context.

public GetStepExecutionContext ( ) : object>.IReadOnlyDictionary
Результат	object>.IReadOnlyDictionary

GetStepName() публичный Метод

Convenient accessor for current step name identifier. Usually this is the same as the bean name of the step that is executing (but might not be e.g. in a partition).

public GetStepName ( ) : string
Результат	string

RegisterDestructionCallback() публичный Метод

Allow clients to register callbacks for clean up on close.

public RegisterDestructionCallback ( string name, System.Threading.Tasks.Task callback ) : void
name	string	the callback id (unique attribute key in this context)
callback	System.Threading.Tasks.Task	a callback to execute on close
Результат	void

RemoveAttribute() публичный Метод

Override base class behaviour to ensure destruction callbacks are unregistered as well as the default behaviour.

public RemoveAttribute ( string name ) : object
name	string
Результат	object

StepContext() публичный Метод

Create a new instance of StepContext for this StepExecution.

public StepContext ( StepExecution stepExecution ) : System
stepExecution	StepExecution
Результат	System

ToString() публичный Метод

ToString override.

public ToString ( ) : string
Результат	string