DefaultEntityState (org.qi4j.core.spi 2.1 API)

java.lang.Object
- org.qi4j.spi.entitystore.helpers.DefaultEntityState

All Implemented Interfaces:: EntityState

public final class DefaultEntityState
extends Object
implements EntityState

Standard implementation of EntityState.

Constructor Summary

Constructors
Constructor and Description
`DefaultEntityState(long currentTime, org.qi4j.api.entity.EntityReference identity, org.qi4j.api.entity.EntityDescriptor entityDescriptor)`
DefaultEntityState(String version, long lastModified, org.qi4j.api.entity.EntityReference identity, EntityStatus status, org.qi4j.api.entity.EntityDescriptor entityDescriptor, Map<org.qi4j.api.common.QualifiedName,Object> properties, Map<org.qi4j.api.common.QualifiedName,org.qi4j.api.entity.EntityReference> associations, Map<org.qi4j.api.common.QualifiedName,List<org.qi4j.api.entity.EntityReference>> manyAssociations, Map<org.qi4j.api.common.QualifiedName,Map<String,org.qi4j.api.entity.EntityReference>> namedAssociations)

Method Summary

Methods
Modifier and Type	Method and Description
`Map<org.qi4j.api.common.QualifiedName,org.qi4j.api.entity.EntityReference>`	`associations()`
`org.qi4j.api.entity.EntityReference`	`associationValueOf(org.qi4j.api.common.QualifiedName stateName)`
`void`	`copyTo(DefaultEntityState entityState)`
`org.qi4j.api.entity.EntityDescriptor`	`entityDescriptor()`
`org.qi4j.api.entity.EntityReference`	`identity()` Returns the identity of the entity that this EntityState represents.
`boolean`	`isAssignableTo(Class<?> type)`
`long`	`lastModified()` Last modified timestamp of the entity.
`Map<org.qi4j.api.common.QualifiedName,List<org.qi4j.api.entity.EntityReference>>`	`manyAssociations()`
`ManyAssociationState`	`manyAssociationValueOf(org.qi4j.api.common.QualifiedName stateName)`
`void`	`markUpdated()`
`Map<org.qi4j.api.common.QualifiedName,Map<String,org.qi4j.api.entity.EntityReference>>`	`namedAssociations()`
`NamedAssociationState`	`namedAssociationValueOf(org.qi4j.api.common.QualifiedName stateName)`
`Map<org.qi4j.api.common.QualifiedName,Object>`	`properties()`
`Object`	`propertyValueOf(org.qi4j.api.common.QualifiedName stateName)`
`void`	`remove()` Remove the entity represented by this EntityState when the unit of work is completed.
`void`	`setAssociationValue(org.qi4j.api.common.QualifiedName stateName, org.qi4j.api.entity.EntityReference newEntity)`
`void`	`setPropertyValue(org.qi4j.api.common.QualifiedName stateName, Object newValue)`
`EntityStatus`	`status()` The status of this EntityState
`String`	`toString()`
`String`	`version()` Version of the entity.

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

Constructor Detail

DefaultEntityState

public DefaultEntityState(long currentTime,
                  org.qi4j.api.entity.EntityReference identity,
                  org.qi4j.api.entity.EntityDescriptor entityDescriptor)

DefaultEntityState

public DefaultEntityState(String version,
                  long lastModified,
                  org.qi4j.api.entity.EntityReference identity,
                  EntityStatus status,
                  org.qi4j.api.entity.EntityDescriptor entityDescriptor,
                  Map<org.qi4j.api.common.QualifiedName,Object> properties,
                  Map<org.qi4j.api.common.QualifiedName,org.qi4j.api.entity.EntityReference> associations,
                  Map<org.qi4j.api.common.QualifiedName,List<org.qi4j.api.entity.EntityReference>> manyAssociations,
                  Map<org.qi4j.api.common.QualifiedName,Map<String,org.qi4j.api.entity.EntityReference>> namedAssociations)

Method Detail
- version
```
public final String version()
```
  Description copied from interface: EntityState
  
  Version of the entity. This is managed by the EntityStore.
  If the underlying EntityStore does not support versioning, then version must always be set to 0.
  
  Specified by:
  
  version in interface EntityState
  
  Returns:
  version of the entity
- lastModified
```
public long lastModified()
```
  Description copied from interface: EntityState
  
  Last modified timestamp of the entity. This is managed by the EntityStore.
  If the underlying EntityStore does not support timestamping, then last modified must always be set to the current time.
  
  Specified by:
  
  lastModified in interface EntityState
  
  Returns:
  last modified timestamp of the entity, as defined by System.currentTimeMillis()
- identity
```
public org.qi4j.api.entity.EntityReference identity()
```
  Description copied from interface: EntityState
  
  Returns the identity of the entity that this EntityState represents.
  
  Specified by:
  
  identity in interface EntityState
  
  Returns:
  the identity of the entity that this EntityState represents.
- propertyValueOf
```
public Object propertyValueOf(org.qi4j.api.common.QualifiedName stateName)
```
  Specified by:
  
  propertyValueOf in interface EntityState
- setPropertyValue
```
public void setPropertyValue(org.qi4j.api.common.QualifiedName stateName,
                    Object newValue)
```
  Specified by:
  
  setPropertyValue in interface EntityState
- associationValueOf
```
public org.qi4j.api.entity.EntityReference associationValueOf(org.qi4j.api.common.QualifiedName stateName)
```
  Specified by:
  
  associationValueOf in interface EntityState
- setAssociationValue
```
public void setAssociationValue(org.qi4j.api.common.QualifiedName stateName,
                       org.qi4j.api.entity.EntityReference newEntity)
```
  Specified by:
  
  setAssociationValue in interface EntityState
- manyAssociationValueOf
```
public ManyAssociationState manyAssociationValueOf(org.qi4j.api.common.QualifiedName stateName)
```
  Specified by:
  
  manyAssociationValueOf in interface EntityState
- namedAssociationValueOf
```
public NamedAssociationState namedAssociationValueOf(org.qi4j.api.common.QualifiedName stateName)
```
  Specified by:
  
  namedAssociationValueOf in interface EntityState
- copyTo
```
public void copyTo(DefaultEntityState entityState)
```
- remove
```
public void remove()
```
  Description copied from interface: EntityState
  
  Remove the entity represented by this EntityState when the unit of work is completed.
  
  Specified by:
  
  remove in interface EntityState
- status
```
public EntityStatus status()
```
  Description copied from interface: EntityState
  
  The status of this EntityState
  
  Specified by:
  
  status in interface EntityState
  
  Returns:
  the status
- isAssignableTo
```
public boolean isAssignableTo(Class<?> type)
```
  Specified by:
  
  isAssignableTo in interface EntityState
- entityDescriptor
```
public org.qi4j.api.entity.EntityDescriptor entityDescriptor()
```
  Specified by:
  
  entityDescriptor in interface EntityState
- properties
```
public Map<org.qi4j.api.common.QualifiedName,Object> properties()
```
- associations
```
public Map<org.qi4j.api.common.QualifiedName,org.qi4j.api.entity.EntityReference> associations()
```
- manyAssociations
```
public Map<org.qi4j.api.common.QualifiedName,List<org.qi4j.api.entity.EntityReference>> manyAssociations()
```
- namedAssociations
```
public Map<org.qi4j.api.common.QualifiedName,Map<String,org.qi4j.api.entity.EntityReference>> namedAssociations()
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- markUpdated
```
public void markUpdated()
```

Class DefaultEntityState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultEntityState

DefaultEntityState

Method Detail

version

lastModified

identity

propertyValueOf

setPropertyValue

associationValueOf

setAssociationValue

manyAssociationValueOf

namedAssociationValueOf

copyTo

remove

status

isAssignableTo

entityDescriptor

properties

associations

manyAssociations

namedAssociations

toString

markUpdated