summaryrefslogtreecommitdiff
path: root/src/main/java/events/implementations/VSTimestampTriggeredEvent.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/VSTimestampTriggeredEvent.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/VSTimestampTriggeredEvent.java')
-rw-r--r--src/main/java/events/implementations/VSTimestampTriggeredEvent.java16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/main/java/events/implementations/VSTimestampTriggeredEvent.java b/src/main/java/events/implementations/VSTimestampTriggeredEvent.java
index ef99104..c5e5386 100644
--- a/src/main/java/events/implementations/VSTimestampTriggeredEvent.java
+++ b/src/main/java/events/implementations/VSTimestampTriggeredEvent.java
@@ -14,7 +14,21 @@ import serialize.VSSerialize;
/**
* Abstract base class for timestamp-triggered events that fire when specific
* Lamport or vector clock conditions are met.
- *
+ *
+ * <p>This class provides the foundation for creating events that trigger based on
+ * timestamp conditions. Subclasses can define events that fire when:</p>
+ * <ul>
+ * <li>Lamport time reaches a specific value</li>
+ * <li>Vector clock matches certain conditions</li>
+ * <li>Custom timestamp comparisons are satisfied</li>
+ * </ul>
+ *
+ * <p>Events can use various comparison operators (equal, greater than, less than, etc.)
+ * and will only trigger once when their condition is first met.</p>
+ *
+ * @see VSLamportTimestampEvent
+ * @see VSVectorTimestampEvent
+ * @see VSTimestampMonitorEvent
* @author Paul C. Buetow
*/
public abstract class VSTimestampTriggeredEvent extends VSAbstractEvent implements VSCopyableEvent {