org.axonframework.modelling.saga

Class SagaScopeDescriptor

java.lang.Object

org.axonframework.modelling.saga.SagaScopeDescriptor

All Implemented Interfaces:

Serializable, ScopeDescriptor

Direct Known Subclasses:

SagaScopeDescriptor

public class SagaScopeDescriptor
extends Object
implements ScopeDescriptor

Describes the scope of a Saga by means of its type and identifier.

Since:

3.3

Author:

Steven van Beelen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SagaScopeDescriptor(String type, Object identifier) Instantiate a SagaScopeDescriptor with the provided type and identifier.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	getIdentifier() The identifier of the Saga targeted with this scope
String	getType() The type of Saga described by this scope
int	hashCode()
String	scopeDescription() Retrieve a String description of a Scope object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SagaScopeDescriptor

@ConstructorProperties(value={"type","identifier"})
public SagaScopeDescriptor(String type,
                                                                               Object identifier)

Instantiate a SagaScopeDescriptor with the provided type and identifier.

Parameters:

type - A String describing the type of the Saga

identifier - An Object denoting the identifier of the Saga

Method Detail

getType

public String getType()

The type of Saga described by this scope

Returns:

the type of Saga described by this scope

getIdentifier

public Object getIdentifier()

The identifier of the Saga targeted with this scope

Returns:

identifier of the Saga targeted with this scope

scopeDescription

public String scopeDescription()

Description copied from interface: ScopeDescriptor

Retrieve a String description of a Scope object.

Specified by:

scopeDescription in interface ScopeDescriptor

Returns:

a String description of a Scope object

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