InitialEventRepresentation (Axon Framework 4.5.8 API)

java.lang.Object
- org.axonframework.serialization.upcasting.event.InitialEventRepresentation

All Implemented Interfaces:

IntermediateEventRepresentation
```
public class InitialEventRepresentation
extends Object
implements IntermediateEventRepresentation
```
Implementation of an IntermediateEventRepresentation that contains the original serialized payload and metadata before these have been upcast. Usually there is one InitialEventRepresentation per event entry from the data store.

Since:

3.0

Author:

Rene de Waele

Constructor Summary

Constructors
Constructor and Description
`InitialEventRepresentation(EventData<?> eventData, Serializer serializer)` Initializes an `InitialEventRepresentation` from the given `eventData`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canConvertDataTo(Class<?> requiredType)` Checks if the data can be converted to the given `requiredType`.
`Optional<String>`	`getAggregateIdentifier()` Returns the Identifier of the Aggregate to which the Event owning the object to upcast, was applied.
`Optional<String>`	`getAggregateType()` Returns the Type of the Aggregate to which the Event owning the object to upcast, was applied.
`SerializedObject<?>`	`getData()` Get the data of this representation.
`<D> SerializedObject<D>`	`getData(Class<D> requiredType)` Get the data of this representation.
`String`	`getMessageIdentifier()` Returns the identifier of the message wrapping the object to upcast.
`LazyDeserializingObject<MetaData>`	`getMetaData()` Returns the meta data of the message wrapping the object being upcast.
`Optional<Long>`	`getSequenceNumber()` Returns the sequence number of the event in the aggregate, or an empty Optional if the message wrapping the object being upcast does not contain a sequence number.
`Instant`	`getTimestamp()` Returns the timestamp at which the event was first created.
`Optional<TrackingToken>`	`getTrackingToken()` Returns the tracking token of the event, or an empty Optional if the message wrapping the object being upcast does not contain a tracking token.
`SerializedType`	`getType()` Returns the type and version of the data contained in this representation.
`<T> IntermediateEventRepresentation`	`upcast(SerializedType outputType, Class<T> expectedRepresentationType, Function<T,T> upcastFunction, Function<MetaData,MetaData> metaDataUpcastFunction)` Upcast the serialized payload of the event (leaving other aspects of the event the same).

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

Methods inherited from interface org.axonframework.serialization.upcasting.event.IntermediateEventRepresentation
upcastPayload

- Constructor Detail
  - InitialEventRepresentation
```
public InitialEventRepresentation(EventData<?> eventData,
                                  Serializer serializer)
```
    Initializes an InitialEventRepresentation from the given eventData. The provided serializer is used to deserialize metadata if the metadata is required during upcasting. The serializer also provides the Converter used to convert serialized data from one format to another if required by any upcaster.
    
    Parameters:
    
    eventData - the serialized event data
    
    serializer - the serializer to deserialize metadata and provide the converter factory
- Method Detail
  - upcast
```
public <T> IntermediateEventRepresentation upcast(SerializedType outputType,
                                                  Class<T> expectedRepresentationType,
                                                  Function<T,T> upcastFunction,
                                                  Function<MetaData,MetaData> metaDataUpcastFunction)
```
    Description copied from interface: IntermediateEventRepresentation
    
    Upcast the serialized payload of the event (leaving other aspects of the event the same).
    
    Specified by:
    
    upcast in interface IntermediateEventRepresentation
    
    Type Parameters:
    
    T - The expected payload type before and after upcasting
    
    Parameters:
    
    outputType - The output type of the event after upcasting
    
    expectedRepresentationType - The type of the serialized payload required by the upcast function
    
    upcastFunction - The upcast function for the event's payload
    
    metaDataUpcastFunction - The upcast function for the event's metadata
    
    Returns:
    
    The intermediate representation of the event after upcasting
  - getType
```
public SerializedType getType()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the type and version of the data contained in this representation.
    
    Specified by:
    
    getType in interface IntermediateEventRepresentation
    
    Returns:
    
    the type and version of the represented data
  - getData
```
public SerializedObject<?> getData()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Get the data of this representation. The type of the returned data should match that of IntermediateEventRepresentation.getType().
    
    Specified by:
    
    getData in interface IntermediateEventRepresentation
    
    Returns:
    
    the data representation of the object
  - getData
```
public <D> SerializedObject<D> getData(Class<D> requiredType)
```
    Description copied from interface: IntermediateEventRepresentation
    
    Get the data of this representation. The type of the returned data will be converted to the given requiredType.
    
    Specified by:
    
    getData in interface IntermediateEventRepresentation
    
    Parameters:
    
    requiredType - the type to convert to
    
    Returns:
    
    the data representation of the object converted to the required type
  - getMessageIdentifier
```
public String getMessageIdentifier()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the identifier of the message wrapping the object to upcast.
    
    Specified by:
    
    getMessageIdentifier in interface IntermediateEventRepresentation
    
    Returns:
    
    the identifier of the message wrapping the object to upcast
  - getAggregateType
```
public Optional<String> getAggregateType()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the Type of the Aggregate to which the Event owning the object to upcast, was applied. This will return an empty Optional if the object being upcast was not contained in a DomainEventMessage.
    
    Specified by:
    
    getAggregateType in interface IntermediateEventRepresentation
    
    Returns:
    
    the Type of the Aggregate to which the Event was applied, or an empty Optional if not applicable
  - getAggregateIdentifier
```
public Optional<String> getAggregateIdentifier()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the Identifier of the Aggregate to which the Event owning the object to upcast, was applied. This will return an empty Optional if the object being upcast was not contained in a DomainEventMessage.
    
    Specified by:
    
    getAggregateIdentifier in interface IntermediateEventRepresentation
    
    Returns:
    
    the Identifier of the Aggregate to which the Event was applied, or an empty Optional if not applicable
  - getSequenceNumber
```
public Optional<Long> getSequenceNumber()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the sequence number of the event in the aggregate, or an empty Optional if the message wrapping the object being upcast does not contain a sequence number.
    
    Specified by:
    
    getSequenceNumber in interface IntermediateEventRepresentation
    
    Returns:
    
    the sequence number of the event in the aggregate, or an empty Optional if not applicable
  - getTrackingToken
```
public Optional<TrackingToken> getTrackingToken()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the tracking token of the event, or an empty Optional if the message wrapping the object being upcast does not contain a tracking token.
    
    Specified by:
    
    getTrackingToken in interface IntermediateEventRepresentation
    
    Returns:
    
    the tracking token of the event, or an empty Optional if not applicable
  - getTimestamp
```
public Instant getTimestamp()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the timestamp at which the event was first created. Will return null if the object being upcast
    
    Specified by:
    
    getTimestamp in interface IntermediateEventRepresentation
    
    Returns:
    
    the timestamp at which the event was first created, if available
  - getMetaData
```
public LazyDeserializingObject<MetaData> getMetaData()
```
    Description copied from interface: IntermediateEventRepresentation
    
    Returns the meta data of the message wrapping the object being upcast. If the meta data is not available, or is in fact the subject of being upcast itself, this method returns null.
    
    Specified by:
    
    getMetaData in interface IntermediateEventRepresentation
    
    Returns:
    
    the MetaData of the message wrapping the object to upcast, if available
  - canConvertDataTo
```
public boolean canConvertDataTo(Class<?> requiredType)
```
    Description copied from interface: IntermediateEventRepresentation
    
    Checks if the data can be converted to the given requiredType.
    
    Specified by:
    
    canConvertDataTo in interface IntermediateEventRepresentation
    
    Parameters:
    
    requiredType - the type to validate if the contained data can be converted to.
    
    Returns:
    
    true, if the intermediate representation's data can be converted to desired type, false otherwise

Class InitialEventRepresentation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.axonframework.serialization.upcasting.event.IntermediateEventRepresentation

Constructor Detail

InitialEventRepresentation

Method Detail

upcast

getType

getData

getData

getMessageIdentifier

getAggregateType

getAggregateIdentifier

getSequenceNumber

getTrackingToken

getTimestamp

getMetaData

canConvertDataTo