A (xuml-tools 0.5 API)

java.lang.Object
- two_transitions_to_same_state.A

All Implemented Interfaces:: Entity<A>

@Entity
public class A
extends Object
implements Entity<A>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`A.Attribute`
`static interface`	`A.Behaviour` On entry procedures for this entity.
`static interface`	`A.BehaviourFactory` A factory that creates behaviour for a given entity.
`static class`	`A.Events` Event declarations.
`static class`	`A.State` The list of all states from the state machine for this entity.

Constructor Summary

Constructors
Constructor and Description

A()
No argument constructor required by JPA.

A(Integer id)
Constructor using id.

Constructors
Constructor and Description
`A()` No argument constructor required by JPA.
`A(Integer id)` Constructor using id.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`A`	`cancelSignal(Event<A> event)`
`A`	`cancelSignal(String eventSignatureKey)`
`static A`	`create(CreationEvent<A> creationEvent)` Static creator method using CreationEvent.
`static A`	`create(javax.persistence.EntityManager em, CreationEvent<A> event)` Static creator method associated with the creation transition to 'Created' via event 'Create'.
`static A`	`create(Integer id)` Static creator method using id.
`static A.BehaviourFactory`	`createBehaviourFactory(Class<? extends A.Behaviour> cls)` Returns a BehaviourFactory on the assumption that the given class has a single constructor with one parameter of type A.
`A`	`delete()` Same as this.remove()
`A`	`event(Event<A> event)` Synchronously runs the on entry procedure associated with this event and also any signals to self that are made during the procedure.
`static com.google.common.base.Optional<A>`	`find(Integer id)`
`static A.BehaviourFactory`	`getBehaviourFactory()` Returns the singleton BehaviourFactory for this.
`Integer`	`getId()` Returns the identifier for this entity.
`String`	`getState()` For internal use only by the state machine but is persisted by the jpa provider.
`EntityHelper`	`helper()` Returns the Helper for this instance.
`A`	`load()`
`A`	`load(javax.persistence.EntityManager em)` Does a merge then a refresh and returns a new updated merged instance.
`A`	`merge(javax.persistence.EntityManager em)` Same as EntityManager.merge() except allows method chaining.
`A`	`persist()` Same as `persist(Context.em())`.
`A`	`persist(javax.persistence.EntityManager em)` Same as EntityManager.persist() except allows method chaining.
`A`	`refresh(javax.persistence.EntityManager em)` Same as EntityManager.refresh() except inverted to facilitate method chaining.
`A`	`remove()` Same as EntityManager.remove() except inverted to facilitate method chaining.
`A`	`remove(javax.persistence.EntityManager em)` Same as EntityManager.remove() except inverted to facilitate method chaining.
`static SelectBuilder<A>`	`select()`
`static SelectBuilder<A>`	`select(BooleanExpression<A> where)`
`static void`	`setBehaviourFactory(A.BehaviourFactory factory)` Sets the BehaviourFactory for all instances of this class.
`static void`	`setBehaviourFactory(Class<? extends A.Behaviour> cls)` Sets the BehaviourFactory for all instances of this class using the given Behaviour class as the base.
`A`	`setId_(Integer id)`
`void`	`setId(Integer id)`
`void`	`setState(A.State state)` Sets the current state.
`void`	`setState(String state)` For internal use only by the state machine but is persisted by the jpa provider.
`A`	`signal(Event<A> event)` Asychronously queues the given signal against this entity for processing.
`A`	`signal(Event<A> event, scala.concurrent.duration.Duration delay)` Asychronously queues the given signal against this entity for processing after the delay specified.
`A`	`signal(Event<A> event, long time)` Asychronously queues the given signal against this entity for processing at the epoch time in ms specified.
`String`	`uniqueId()` Returns a unique id for this instance as a String.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - A
```
public A()
```
    No argument constructor required by JPA.
  - A
```
public A(Integer id)
```
    Constructor using id.
- Method Detail
  - setBehaviourFactory
```
public static void setBehaviourFactory(A.BehaviourFactory factory)
```
    Sets the BehaviourFactory for all instances of this class. It will only be used when Behaviour is not explicitly provided in the constructor.
  - setBehaviourFactory
```
public static void setBehaviourFactory(Class<? extends A.Behaviour> cls)
```
    Sets the BehaviourFactory for all instances of this class using the given Behaviour class as the base. It will only be used when Behaviour is not explicitly provided in the constructor.
  - getBehaviourFactory
```
public static A.BehaviourFactory getBehaviourFactory()
```
    Returns the singleton BehaviourFactory for this.
  - create
```
public static A create(Integer id)
```
    Static creator method using id.
  - create
```
public static A create(CreationEvent<A> creationEvent)
```
    Static creator method using CreationEvent.
  - helper
```
public EntityHelper helper()
```
    Returns the Helper for this instance.
    
    Specified by:
    
    helper in interface Entity<A>
    
    Returns:
  - uniqueId
```
public String uniqueId()
```
    Returns a unique id for this instance as a String. Used for synchronizing access to entities.
    
    Specified by:
    
    uniqueId in interface Entity<A>
    
    Returns:
  - getId
```
public Integer getId()
```
    Returns the identifier for this entity.
    
    Specified by:
    
    getId in interface Entity<A>
  - setId
```
public void setId(Integer id)
```
  - setId_
```
public A setId_(Integer id)
```
  - getState
```
public String getState()
```
    For internal use only by the state machine but is persisted by the jpa provider.
  - setState
```
public void setState(String state)
```
    For internal use only by the state machine but is persisted by the jpa provider.
  - setState
```
public void setState(A.State state)
```
    Sets the current state. This should only be used when creating an instance without using the state machine.
  - signal
```
public A signal(Event<A> event)
```
    Asychronously queues the given signal against this entity for processing.
    
    Specified by:
    
    signal in interface Entity<A>
  - signal
```
public A signal(Event<A> event,
                scala.concurrent.duration.Duration delay)
```
    Asychronously queues the given signal against this entity for processing after the delay specified. Delay cannot be null.
    
    Specified by:
    
    signal in interface Entity<A>
  - signal
```
public A signal(Event<A> event,
                long time)
```
    Asychronously queues the given signal against this entity for processing at the epoch time in ms specified. Delay cannot be null.
    
    Specified by:
    
    signal in interface Entity<A>
  - cancelSignal
```
public A cancelSignal(String eventSignatureKey)
```
  - cancelSignal
```
public A cancelSignal(Event<A> event)
```
  - event
```
public A event(Event<A> event)
```
    Synchronously runs the on entry procedure associated with this event and also any signals to self that are made during the procedure. This method should not be called directly except in a unit testing scenario perhaps. Call signal method instead.
    
    Specified by:
    
    event in interface Entity<A>
  - create
```
public static A create(javax.persistence.EntityManager em,
                       CreationEvent<A> event)
```
    Static creator method associated with the creation transition to 'Created' via event 'Create'.
  - merge
```
public A merge(javax.persistence.EntityManager em)
```
    Same as EntityManager.merge() except allows method chaining. Returns a new merged instance.
  - persist
```
public A persist(javax.persistence.EntityManager em)
```
    Same as EntityManager.persist() except allows method chaining. Returns this.
  - persist
```
public A persist()
```
    Same as persist(Context.em()). Returns this.
  - remove
```
public A remove(javax.persistence.EntityManager em)
```
    Same as EntityManager.remove() except inverted to facilitate method chaining. Returns this.
  - remove
```
public A remove()
```
    Same as EntityManager.remove() except inverted to facilitate method chaining. Returns this.
  - delete
```
public A delete()
```
    Same as this.remove()
  - refresh
```
public A refresh(javax.persistence.EntityManager em)
```
    Same as EntityManager.refresh() except inverted to facilitate method chaining. Returns this.
  - load
```
public A load(javax.persistence.EntityManager em)
```
    Does a merge then a refresh and returns a new updated merged instance.
  - load
```
public A load()
```
  - createBehaviourFactory
```
public static A.BehaviourFactory createBehaviourFactory(Class<? extends A.Behaviour> cls)
```
    Returns a BehaviourFactory on the assumption that the given class has a single constructor with one parameter of type A.
  - find
```
public static com.google.common.base.Optional<A> find(Integer id)
```
  - select
```
public static SelectBuilder<A> select(BooleanExpression<A> where)
```
  - select
```
public static SelectBuilder<A> select()
```

Class A

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

A

A

Method Detail

setBehaviourFactory

setBehaviourFactory

getBehaviourFactory

create

create

helper

uniqueId

getId

setId

setId_

getState

setState

setState

signal

signal

signal

cancelSignal

cancelSignal

event

create

merge

persist

persist

remove

remove

delete

refresh

load

load

createBehaviourFactory

find

select

select