Skip to content

Commit db290a6

Browse files
smcvbsmcvb
committed
Clean up module
- align pom with main pom - update readme according to style guide - fix warnings - align code with style guide - change POJOs into records when applicable - fix broken links - remove useless javadoc #clean-up
1 parent beb5b95 commit db290a6

10 files changed

+63
-221
lines changed

‎upcaster/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ The FlightDelayedEvent is used as example. The original (null) revision looks li
1515

1616
```
1717

18-
Then a new requirement popped up to put the origin and destination into a separate object called `leg`. Please note, that this is
19-
just an example, and we do recommend keeping your event structure as flat as possible. The upcasted event should look like
20-
this:
18+
Then a new requirement popped up to put the origin and destination into a separate object called `leg`. Please note,
19+
that this is just an example, and we do recommend keeping your event structure as flat as possible. The upcasted event
20+
should look like this:
2121

2222
```json
2323
{
@@ -31,10 +31,10 @@ this:
3131
```
3232

3333
You can find the implementation of the upcaster in
34-
the [FlightDelayedEventUpcaster](src/main/java/io/axoniq/dev/samples/upcaster/FlightDelayedEventUpcaster.java). The
35-
implementation of the test can be
36-
found [here](src/test/java/io/axoniq/dev/samples/upcaster/FlightDelayedEventUpcasterTest.java)
34+
the [FlightDelayedEventUpcaster](src/main/java/io/axoniq/dev/samples/upcaster/json/FlightDelayedEvent0_to_1Upcaster.java).
35+
The implementation of the test can be
36+
found [here](src/test/java/io/axoniq/dev/samples/upcaster/json/FlightDelayedEvent0_To_1UpcasterTest.java)
3737

3838
To get this upcaster invoked on the event handler it should be added to
39-
the [EventUpcasterChainFactory](src/main/java/io/axoniq/dev/samples/upcaster/EventUpcasterChainFactory.java) or
39+
the [EventUpcasterChainFactory](src/main/java/io/axoniq/dev/samples/upcaster/json/EventUpcasterChainFactory.java) or
4040
annotate it as a Spring component together with an Order annotation.

‎upcaster/pom.xml

+26-22
Original file line numberDiff line numberDiff line change
@@ -5,51 +5,55 @@
55
<parent>
66
<artifactId>code-samples</artifactId>
77
<groupId>io.axoniq</groupId>
8-
<version>0.0.1-SNAPSHOT</version>
8+
<version>0.0.2-SNAPSHOT</version>
99
</parent>
1010
<modelVersion>4.0.0</modelVersion>
1111

1212
<artifactId>upcaster</artifactId>
13-
14-
<build>
15-
<plugins>
16-
<plugin>
17-
<groupId>org.apache.maven.plugins</groupId>
18-
<artifactId>maven-compiler-plugin</artifactId>
19-
<configuration>
20-
<source>8</source>
21-
<target>8</target>
22-
</configuration>
23-
</plugin>
24-
<plugin>
25-
<groupId>org.springframework.boot</groupId>
26-
<artifactId>spring-boot-maven-plugin</artifactId>
27-
</plugin>
28-
</plugins>
29-
</build>
13+
14+
<name>Upcaster</name>
15+
<description>Module showing several Upcaster implementations</description>
3016

3117
<dependencies>
18+
<!-- Axon -->
3219
<dependency>
3320
<groupId>org.axonframework</groupId>
3421
<artifactId>axon-spring-boot-starter</artifactId>
3522
</dependency>
23+
<!-- Spring -->
3624
<dependency>
3725
<groupId>org.springframework.boot</groupId>
3826
<artifactId>spring-boot-starter-web</artifactId>
3927
</dependency>
40-
<dependency>
41-
<groupId>org.junit.jupiter</groupId>
42-
<artifactId>junit-jupiter</artifactId>
43-
</dependency>
28+
<!-- Testing -->
4429
<dependency>
4530
<groupId>org.skyscreamer</groupId>
4631
<artifactId>jsonassert</artifactId>
4732
<scope>test</scope>
4833
</dependency>
34+
<dependency>
35+
<groupId>org.junit.jupiter</groupId>
36+
<artifactId>junit-jupiter</artifactId>
37+
</dependency>
38+
4939
<dependency>
5040
<groupId>org.json</groupId>
5141
<artifactId>json</artifactId>
5242
</dependency>
5343
</dependencies>
5444

45+
<build>
46+
<plugins>
47+
<!-- TODO perhaps remove if in main pom-->
48+
<plugin>
49+
<groupId>org.apache.maven.plugins</groupId>
50+
<artifactId>maven-compiler-plugin</artifactId>
51+
</plugin>
52+
<!-- TODO perhaps remove if in main pom-->
53+
<plugin>
54+
<groupId>org.springframework.boot</groupId>
55+
<artifactId>spring-boot-maven-plugin</artifactId>
56+
</plugin>
57+
</plugins>
58+
</build>
5559
</project>

‎upcaster/src/main/java/io/axoniq/dev/samples/api/AirportCode.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ public enum AirportCode {
77
NYC("New York City"),
88
LAX("Los Angeles");
99

10-
AirportCode(String airportName) {
10+
AirportCode(@SuppressWarnings("unused") String airportName) {
1111
}
1212
}

‎upcaster/src/main/java/io/axoniq/dev/samples/api/FlightDelayedEvent.java

+5-49
Original file line numberDiff line numberDiff line change
@@ -6,54 +6,10 @@
66
import java.util.Objects;
77

88
@Revision("1.0")
9-
public class FlightDelayedEvent {
9+
public record FlightDelayedEvent(
10+
String flightId,
11+
Leg leg,
12+
LocalDateTime arrivalTime
13+
) {
1014

11-
private final String flightId;
12-
private final Leg leg;
13-
private final LocalDateTime arrivalTime;
14-
15-
public FlightDelayedEvent(String flightId, Leg leg, LocalDateTime arrivalTime) {
16-
this.flightId = flightId;
17-
this.leg = leg;
18-
this.arrivalTime = arrivalTime;
19-
}
20-
21-
public String getFlightId() {
22-
return flightId;
23-
}
24-
25-
public Leg getLeg() {
26-
return leg;
27-
}
28-
29-
public LocalDateTime getArrivalTime() {
30-
return arrivalTime;
31-
}
32-
33-
@Override
34-
public boolean equals(Object o) {
35-
if (this == o) {
36-
return true;
37-
}
38-
if (o == null || getClass() != o.getClass()) {
39-
return false;
40-
}
41-
FlightDelayedEvent that = (FlightDelayedEvent) o;
42-
return Objects.equals(flightId, that.flightId) && Objects.equals(leg, that.leg)
43-
&& Objects.equals(arrivalTime, that.arrivalTime);
44-
}
45-
46-
@Override
47-
public int hashCode() {
48-
return Objects.hash(flightId, leg, arrivalTime);
49-
}
50-
51-
@Override
52-
public String toString() {
53-
return "FlightDelayedEvent{" +
54-
"flightId='" + flightId + '\'' +
55-
", leg=" + leg +
56-
", arrivalTime=" + arrivalTime +
57-
'}';
58-
}
5915
}

‎upcaster/src/main/java/io/axoniq/dev/samples/api/Leg.java

+4-35
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,8 @@
11
package io.axoniq.dev.samples.api;
22

3-
import java.util.Objects;
3+
public record Leg(
4+
AirportCode origin,
5+
AirportCode destination
6+
) {
47

5-
public class Leg {
6-
7-
private final AirportCode origin;
8-
private final AirportCode destination;
9-
10-
public Leg(AirportCode origin, AirportCode destination) {
11-
this.origin = origin;
12-
this.destination = destination;
13-
}
14-
15-
public AirportCode getOrigin() {
16-
return origin;
17-
}
18-
19-
public AirportCode getDestination() {
20-
return destination;
21-
}
22-
23-
@Override
24-
public boolean equals(Object o) {
25-
if (this == o) {
26-
return true;
27-
}
28-
if (o == null || getClass() != o.getClass()) {
29-
return false;
30-
}
31-
Leg leg = (Leg) o;
32-
return getOrigin() == leg.getOrigin() && getDestination() == leg.getDestination();
33-
}
34-
35-
@Override
36-
public int hashCode() {
37-
return Objects.hash(getOrigin(), getDestination());
38-
}
398
}

‎upcaster/src/main/java/io/axoniq/dev/samples/api/PassengerSeatAdjustedEvent.java

+5-51
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,9 @@
11
package io.axoniq.dev.samples.api;
22

3-
import java.util.Objects;
3+
public record PassengerSeatAdjustedEvent(
4+
String flightId,
5+
String passengerId,
6+
int seatNumber
7+
) {
48

5-
public class PassengerSeatAdjustedEvent {
6-
7-
private final String flightId;
8-
private final String passengerId;
9-
private final int seatNumber;
10-
11-
public PassengerSeatAdjustedEvent(String flightId, String passengerId, int seatNumber) {
12-
this.flightId = flightId;
13-
this.passengerId = passengerId;
14-
this.seatNumber = seatNumber;
15-
}
16-
17-
public String getFlightId() {
18-
return flightId;
19-
}
20-
21-
public String getPassengerId() {
22-
return passengerId;
23-
}
24-
25-
public int getSeatNumber() {
26-
return seatNumber;
27-
}
28-
29-
@Override
30-
public boolean equals(Object o) {
31-
if (this == o) {
32-
return true;
33-
}
34-
if (o == null || getClass() != o.getClass()) {
35-
return false;
36-
}
37-
PassengerSeatAdjustedEvent that = (PassengerSeatAdjustedEvent) o;
38-
return seatNumber == that.seatNumber && Objects.equals(flightId, that.flightId)
39-
&& Objects.equals(passengerId, that.passengerId);
40-
}
41-
42-
@Override
43-
public int hashCode() {
44-
return Objects.hash(flightId, passengerId, seatNumber);
45-
}
46-
47-
@Override
48-
public String toString() {
49-
return "PassengerSeatAdjustedEvent{" +
50-
"flightId='" + flightId + '\'' +
51-
", passengerId='" + passengerId + '\'' +
52-
", seatNumber=" + seatNumber +
53-
'}';
54-
}
559
}

‎upcaster/src/main/java/io/axoniq/dev/samples/api/PassengerSeatsAdjustedEvent.java

+6-44
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,22 @@
11
package io.axoniq.dev.samples.api;
22

33
import java.util.Map;
4-
import java.util.Objects;
54

65
/**
76
* An old event of the flight domain that's now been deprecated.
87
* <p>
98
* This event contained a complete list of all the passenger seat adjustments of a flight in one go. As time passed, the
10-
* application developers noticed they required an event for every separate change. Hence, they introduced that {@link
11-
* PassengerSeatAdjustedEvent} and added a one-to-many upcaster to make this adjustment.
9+
* application developers noticed they required an event for every separate change. Hence, they introduced that
10+
* {@link PassengerSeatAdjustedEvent} and added a one-to-many upcaster to make this adjustment.
1211
*
1312
* @author Steven van Beelen
1413
* @see io.axoniq.dev.samples.upcaster.json.PassengerSeatsToPassengerSeatAdjustedEventUpcaster
1514
* @deprecated in favor of singular {@link PassengerSeatAdjustedEvent}s
1615
*/
1716
@Deprecated
18-
public class PassengerSeatsAdjustedEvent {
17+
public record PassengerSeatsAdjustedEvent(
18+
String flightId,
19+
Map<String, Integer> passengerSeats
20+
) {
1921

20-
private final String flightId;
21-
private final Map<String, Integer> passengerSeats;
22-
23-
public PassengerSeatsAdjustedEvent(String flightId, Map<String, Integer> passengerSeats) {
24-
this.flightId = flightId;
25-
this.passengerSeats = passengerSeats;
26-
}
27-
28-
public String getFlightId() {
29-
return flightId;
30-
}
31-
32-
public Map<String, Integer> getPassengerSeats() {
33-
return passengerSeats;
34-
}
35-
36-
@Override
37-
public boolean equals(Object o) {
38-
if (this == o) {
39-
return true;
40-
}
41-
if (o == null || getClass() != o.getClass()) {
42-
return false;
43-
}
44-
PassengerSeatsAdjustedEvent that = (PassengerSeatsAdjustedEvent) o;
45-
return Objects.equals(flightId, that.flightId) && Objects.equals(passengerSeats, that.passengerSeats);
46-
}
47-
48-
@Override
49-
public int hashCode() {
50-
return Objects.hash(flightId, passengerSeats);
51-
}
52-
53-
@Override
54-
public String toString() {
55-
return "PassengerSeatsAdjustedEvent{" +
56-
"flightId='" + flightId + '\'' +
57-
", passengerSeats=" + passengerSeats +
58-
'}';
59-
}
6022
}

‎upcaster/src/main/java/io/axoniq/dev/samples/upcaster/json/EventUpcasterChainFactory.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,19 @@
66
import java.util.function.Function;
77

88
/**
9-
* Utility class constructing the {@link EventUpcasterChain} to configure on the {@link
10-
* org.axonframework.eventsourcing.eventstore.EventStore}.
9+
* Utility class constructing the {@link EventUpcasterChain} to configure on the
10+
* {@link org.axonframework.eventsourcing.eventstore.EventStore}.
1111
* <p>
1212
* In a Spring Boot environment exposing an {@code EventUpcasterChain} bean is sufficient for the framework to pick it
1313
* up correctly. To that end we can use the {@link #buildEventUpcasterChain()} method.
1414
* <p>
1515
* When using Axon's {@link org.axonframework.config.Configurer} directly, you should configure all upcasters separately
16-
* by invoking the {@link org.axonframework.config.Configurer#registerEventUpcaster(Function)} method. The {@link
17-
* #configureUpcasters(Configurer)} shows how we should implement this.
16+
* by invoking the {@link org.axonframework.config.Configurer#registerEventUpcaster(Function)} method. The
17+
* {@link #configureUpcasters(Configurer)} shows how we should implement this.
1818
*
1919
* @author Yvonne Ceelie
2020
*/
21+
@SuppressWarnings("unused")
2122
public abstract class EventUpcasterChainFactory {
2223

2324
/**

‎upcaster/src/main/java/io/axoniq/dev/samples/upcaster/json/PassengerSeatsToPassengerSeatAdjustedEventUpcaster.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
import java.util.stream.StreamSupport;
1515

1616
/**
17-
* An upcaster implementation that, instead of returning a single entry, returns a {@link Stream} of {@link
18-
* IntermediateEventRepresentation}s for the {@link io.axoniq.dev.samples.api.PassengerSeatsAdjustedEvent}.
17+
* An upcaster implementation that, instead of returning a single entry, returns a {@link Stream} of
18+
* {@link IntermediateEventRepresentation}s for the {@link io.axoniq.dev.samples.api.PassengerSeatsAdjustedEvent}.
1919
* <p>
2020
* This {@link EventMultiUpcaster} implementation retrieves the {@code "passengerSeats"} collection from the deprecated
21-
* event. Doing os it is able to upcast the single event to the right amount of {@link
22-
* io.axoniq.dev.samples.api.PassengerSeatAdjustedEvent}s.
21+
* event. Doing os it is able to upcast the single event to the right amount of
22+
* {@link io.axoniq.dev.samples.api.PassengerSeatAdjustedEvent}s.
2323
* <p>
2424
* Note that the original event is removed from the result, as it is not part of the returned {@code Stream} by the
2525
* {@link #doUpcast(IntermediateEventRepresentation)} implementation.

‎upcaster/src/test/java/io/axoniq/dev/samples/upcaster/json/UpcasterTestingUtils.java

-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@
1212
import java.util.UUID;
1313
import java.util.stream.Collectors;
1414

15-
/**
16-
* @author Yvonne Ceelie
17-
* @author Steven van Beelen
18-
*/
1915
public abstract class UpcasterTestingUtils {
2016

2117
public static String extractFileContentsToString(String fileName) {

0 commit comments

Comments
 (0)