Skip to content

Commit a76e3b2

Browse files
committed
docs: more code docs
1 parent 047fbe6 commit a76e3b2

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/EventUpcaster.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ import org.axonframework.serialization.upcasting.event.IntermediateEventRepresen
2424
import org.axonframework.serialization.upcasting.event.SingleEventUpcaster
2525
import kotlin.reflect.KClass
2626

27+
/**
28+
* Helpers for event upcaster.
29+
*/
2730
object EventUpcaster {
2831
/**
2932
* Creates a singleEventUpcaster for given type and revisions and calls [IntermediateEventRepresentation#upcastPayload] using the [converter].

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/GenericEventMessageExtensions.kt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ package org.axonframework.extensions.kotlin
2121

2222
import org.axonframework.eventhandling.GenericEventMessage
2323

24+
/**
25+
* Extensions for generic message handling.
26+
*/
2427
object GenericEventMessageExtensions {
28+
/**
29+
* Reified version of asEventMessage.
30+
*/
2531
inline fun <reified P> asEventMessage(event: Any) = GenericEventMessage.asEventMessage<P>(event)
2632
}

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/QueryGatewayExtensions.kt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,27 @@ import java.util.*
2525
import java.util.concurrent.CompletableFuture
2626

2727
/**
28-
* Extensiond to access query gateway.
28+
* Extensions to access query gateway.
2929
*/
3030
object QueryGatewayExtensions {
3131

32+
/**
33+
* Reified version of queryForMultiple.
34+
*/
3235
inline fun <reified R, reified Q> QueryGateway.queryForMultiple(queryName: String, query: Q): CompletableFuture<List<R>> {
3336
return this.query(queryName, query, ResponseTypes.multipleInstancesOf(R::class.java))
3437
}
3538

39+
/**
40+
* Reified version of queryForSingle.
41+
*/
3642
inline fun <reified R, reified Q> QueryGateway.queryForSingle(queryName: String, query: Q): CompletableFuture<R> {
3743
return this.query(queryName, query, ResponseTypes.instanceOf(R::class.java))
3844
}
3945

46+
/**
47+
* Reified version of queryForOptional.
48+
*/
4049
inline fun <reified R, reified Q> QueryGateway.queryForOptional(queryName: String, query: Q): CompletableFuture<Optional<R>> {
4150
return this.query(queryName, query, ResponseTypes.optionalInstanceOf(R::class.java))
4251
}

0 commit comments

Comments
 (0)