summaryrefslogtreecommitdiff
path: root/src/main/java/events/implementations/VSLamportTimestampEvent.java
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-06-20 19:25:10 +0300
committerPaul Buetow <paul@buetow.org>2025-06-20 19:25:10 +0300
commit7ee77637273e2e913cf19f078e9143ae6977f44f (patch)
tree2cda0f82a7bf4c6f76e115f57e28de18d744d5e6 /src/main/java/events/implementations/VSLamportTimestampEvent.java
parent70fc0505b223f7bf17d3671d0532773359cf7858 (diff)
Add comprehensive Javadoc documentation for public APIs
- Document core classes: VSTask, VSMessage, VSInternalProcess - Document event interfaces: VSAbstractEvent, VSCopyableEvent, VSTime - Document timestamp events: VSTimestampTriggeredEvent, VSLamportTimestampEvent - Document protocol framework: VSAbstractProtocol methods - Document VSSimulator and VSRegisteredEvents - Add detailed method descriptions with parameter and return value docs - Include usage examples and cross-references between related classes 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'src/main/java/events/implementations/VSLamportTimestampEvent.java')
-rw-r--r--src/main/java/events/implementations/VSLamportTimestampEvent.java25
1 files changed, 21 insertions, 4 deletions
diff --git a/src/main/java/events/implementations/VSLamportTimestampEvent.java b/src/main/java/events/implementations/VSLamportTimestampEvent.java
index 28da7dc..e82ea24 100644
--- a/src/main/java/events/implementations/VSLamportTimestampEvent.java
+++ b/src/main/java/events/implementations/VSLamportTimestampEvent.java
@@ -6,11 +6,28 @@ import core.VSInternalProcess;
* Concrete implementation of a Lamport timestamp-triggered event.
* This event fires when a specific Lamport timestamp condition is met.
*
- * Example usage:
- * - Fire when Lamport time equals 10
- * - Fire when Lamport time reaches 50 or greater
- * - Fire when Lamport time is less than 5
+ * <p>This class allows you to create events that trigger based on Lamport logical time.
+ * You can specify conditions such as:</p>
+ * <ul>
+ * <li>Fire when Lamport time equals 10</li>
+ * <li>Fire when Lamport time reaches 50 or greater</li>
+ * <li>Fire when Lamport time is less than 5</li>
+ * </ul>
+ *
+ * <p>Example usage:</p>
+ * <pre>{@code
+ * // Create event that fires when Lamport time reaches 100
+ * VSLamportTimestampEvent event = new VSLamportTimestampEvent(
+ * 100, ComparisonOperator.GREATER_EQUAL, "Checkpoint reached");
+ *
+ * // Add custom action
+ * event.setCustomAction(() -> {
+ * System.out.println("Lamport time 100 reached!");
+ * });
+ * }</pre>
*
+ * @see VSTimestampTriggeredEvent
+ * @see VSTimestampMonitorEvent
* @author Paul C. Buetow
*/
public class VSLamportTimestampEvent extends VSTimestampTriggeredEvent {