Summer.Batch.Common.Util.IAttributeAccessor Interface Reference

Interface defining a generic contract for attaching and accessing metadata to/from arbitrary objects. More...

Inheritance diagram for Summer.Batch.Common.Util.IAttributeAccessor:
Summer.Batch.Common.Util.AttributeAccessorSupport Summer.Batch.Infrastructure.Repeat.Context.SynchronizedAttributeAccessor Summer.Batch.Infrastructure.Repeat.IRepeatContext Summer.Batch.Core.Scope.Context.ChunkContext Summer.Batch.Core.Scope.Context.JobContext Summer.Batch.Core.Scope.Context.StepContext Summer.Batch.Infrastructure.Repeat.Context.RepeatContextSupport Summer.Batch.Infrastructure.Repeat.Context.RepeatContextSupport Summer.Batch.Infrastructure.Repeat.Policy.SimpleCompletionPolicy.SimpleTerminationContext Summer.Batch.Infrastructure.Repeat.Policy.SimpleCompletionPolicy.SimpleTerminationContext

Public Member Functions

void SetAttribute (string name, object val)
 Sets the attribute defined by name to the supplied value. If value is null, the attribute is removed. In general, users should take care to prevent overlaps with other metadata attributes by using fully-qualified names, perhaps using class or package names as prefix. More...
 
object GetAttribute (string name)
 Gets the value of the attribute identified by name. Returns null if the attribute doesn't exist. More...
 
object RemoveAttribute (string name)
 Removes the attribute identified by name and return its value. Return null if no attribute under name is found. More...
 
bool HasAttribute (string name)
 Returns true if the attribute identified by name exists. Otherwise return false. More...
 
string[] AttributeNames ()
 Returns the names of all attributes. More...
 

Detailed Description

Interface defining a generic contract for attaching and accessing metadata to/from arbitrary objects.

Member Function Documentation

string [] Summer.Batch.Common.Util.IAttributeAccessor.AttributeNames ( )
object Summer.Batch.Common.Util.IAttributeAccessor.GetAttribute ( string  name)

Gets the value of the attribute identified by name. Returns null if the attribute doesn't exist.

Parameters
name
Returns

Implemented in Summer.Batch.Common.Util.AttributeAccessorSupport, and Summer.Batch.Infrastructure.Repeat.Context.SynchronizedAttributeAccessor.

bool Summer.Batch.Common.Util.IAttributeAccessor.HasAttribute ( string  name)

Returns true if the attribute identified by name exists. Otherwise return false.

Parameters
name
Returns

Implemented in Summer.Batch.Common.Util.AttributeAccessorSupport, and Summer.Batch.Infrastructure.Repeat.Context.SynchronizedAttributeAccessor.

object Summer.Batch.Common.Util.IAttributeAccessor.RemoveAttribute ( string  name)

Removes the attribute identified by name and return its value. Return null if no attribute under name is found.

Parameters
name
Returns

Implemented in Summer.Batch.Core.Scope.Context.StepContext, Summer.Batch.Core.Scope.Context.JobContext, Summer.Batch.Common.Util.AttributeAccessorSupport, and Summer.Batch.Infrastructure.Repeat.Context.SynchronizedAttributeAccessor.

void Summer.Batch.Common.Util.IAttributeAccessor.SetAttribute ( string  name,
object  val 
)

Sets the attribute defined by name to the supplied value. If value is null, the attribute is removed. In general, users should take care to prevent overlaps with other metadata attributes by using fully-qualified names, perhaps using class or package names as prefix.

Parameters
name
val

Implemented in Summer.Batch.Common.Util.AttributeAccessorSupport, and Summer.Batch.Infrastructure.Repeat.Context.SynchronizedAttributeAccessor.


The documentation for this interface was generated from the following file:
  • Summer.Batch.Common/Util/IAttributeAccessor.cs