Assigned either through the {@linkplain #AbstractEntity(Object) constructor which
* accepts the ID}, or via {@link #setId(Object)}. Is never {@code null}.
+ *
+ * @apiNote The field is named with the underscore prefix to avoid
+ * name clash with the extension property name in Kotlin.
*/
- private @MonotonicNonNull I id;
+ @SuppressWarnings("FieldNamingConvention") // See `apiNote` above.
+ private @MonotonicNonNull I _id;
/** Cached version of string ID. */
@LazyInit
@@ -117,14 +121,26 @@ public abstract class AbstractEntity Lazily initialized to the {@linkplain #defaultState() default state},
* if {@linkplain #state() accessed} before {@linkplain #setState(EntityState)}
* initialization}.
+ *
+ * @apiNote The field is named with the underscore prefix to avoid
+ * name clash with the extension property name in Kotlin.
*/
+ @SuppressWarnings("FieldNamingConvention") // See `apiNote` above.
@LazyInit
- private volatile @MonotonicNonNull S state;
+ private volatile @MonotonicNonNull S _state;
- /** The version of the entity. */
- private volatile Version version;
+ /**
+ * The version of the entity.
+ *
+ * @apiNote The field is named with the underscore prefix to avoid
+ * name clash with the extension property name in Kotlin.
+ */
+ @SuppressWarnings("FieldNamingConvention") // See `apiNote` above.
+ private volatile Version _version;
- /** The lifecycle flags of the entity. */
+ /**
+ * The lifecycle flags of the entity.
+ */
private volatile @MonotonicNonNull LifecycleFlags lifecycleFlags;
/**
@@ -135,9 +151,16 @@ public abstract class AbstractEntity This field is {@code null}, if the entity is not being accessed through a receptor.
+ *
+ * @see #beforeInvoke(Receptor)
+ * @see #afterInvoke(Receptor)
+ */
private @Nullable AutoCloseable loggingContext = null;
-
/**
* Creates a new instance with the zero version and cleared lifecycle flags.
*
@@ -163,12 +186,12 @@ protected AbstractEntity(I id) {
@SuppressWarnings("InstanceVariableUsedBeforeInitialized") // checked in `if`
final void setId(I id) {
checkNotNull(id);
- if (this.id != null) {
- checkState(id.equals(this.id),
+ if (this._id != null) {
+ checkState(id.equals(this._id),
"Entity ID already assigned to `%s`." +
- " Attempted to reassign to `%s`.", this.id, id);
+ " Attempted to reassign to `%s`.", this._id, id);
}
- this.id = id;
+ this._id = id;
}
/**
@@ -188,7 +211,7 @@ protected AbstractEntity(I id, Function>
+ E.id: I
+ get() = id()
+
+/**
+ * Obtains the entity version.
+ *
+ * This is a shortcut for `version()`.
+ *
+ * @param I the type of the entity identifiers.
+ * @param E the type of the transactional entity.
+ * @param S the type of the entity state.
+ * @param B the type of the entity state builder.
+ */
+public val >
+ E.version: Version
+ get() = version()
+
+/**
+ * Obtains the entity state.
+ *
+ * This is a shortcut for `state()`.
+ *
+ * @param I the type of the entity identifiers.
+ * @param E the type of the transactional entity.
+ * @param S the type of the entity state.
+ * @param B the type of the entity state builder.
+ */
+public val >
+ E.state: S
+ get() = state()
diff --git a/server/src/test/kotlin/io/spine/server/entity/TransactionalEntityExtensionsSpec.kt b/server/src/test/kotlin/io/spine/server/entity/TransactionalEntityExtensionsSpec.kt
index 877fc17951..b4c3bc1b38 100644
--- a/server/src/test/kotlin/io/spine/server/entity/TransactionalEntityExtensionsSpec.kt
+++ b/server/src/test/kotlin/io/spine/server/entity/TransactionalEntityExtensionsSpec.kt
@@ -37,17 +37,29 @@ internal class TransactionalEntityExtensionsSpec {
@Test
fun `add 'update' block handler for passing properties to 'builder'`() {
val entity = createEntity()
+ val prevVersion = entity.version
+ val prevId = entity.id
val str = randomString()
- entity.applyUpdate(str)
+
+ entity.doUpdate(str)
+
entity.value() shouldBe str
+ entity.version.isIncrement(prevVersion) shouldBe true
+ entity.id shouldBe prevId
}
@Test
fun `add 'alter' block handler for passing properties to 'builder'`() {
val entity = createEntity()
+ val prevVersion = entity.version
+ val prevId = entity.id
val str = randomString()
- entity.txApplyAlteration(str)
+
+ entity.doAlter(str)
+
entity.value() shouldBe str
+ entity.version.isIncrement(prevVersion) shouldBe true
+ entity.id shouldBe prevId
}
}
@@ -64,8 +76,8 @@ private fun createEntity() : Fixture {
}
/**
- * An entity which uses the [TransactionalEntity] extension functions in its [applyUpdate]
- * and [applyAlteration] methods.
+ * An entity which uses the [TransactionalEntity] extension functions in its [doUpdate]
+ * and [doAlter] methods.
*/
private class Fixture : TransactionalEntity