summaryrefslogtreecommitdiff
path: root/sources/events/internal/VSProtocolEvent.java
diff options
context:
space:
mode:
Diffstat (limited to 'sources/events/internal/VSProtocolEvent.java')
-rw-r--r--sources/events/internal/VSProtocolEvent.java42
1 files changed, 26 insertions, 16 deletions
diff --git a/sources/events/internal/VSProtocolEvent.java b/sources/events/internal/VSProtocolEvent.java
index 8b65c79..2720fe7 100644
--- a/sources/events/internal/VSProtocolEvent.java
+++ b/sources/events/internal/VSProtocolEvent.java
@@ -8,19 +8,26 @@ import events.*;
import protocols.VSAbstractProtocol;
/**
- * The Class VSProtocolEvent.
+ * The Class VSProtocolEvent. This event is used if a protocol (server or
+ * client part) of a process gets enabled or disabled. An object of this class
+ * can be for 4 different purporses! Activation of the client protocol,
+ * deactivation of the client protocol, activation of the server protocol,
+ * deactivation of the server protocol.
+ *
+ * @author Paul C. Buetow
*/
public class VSProtocolEvent extends VSAbstractEvent {
+ /** The serial version uid */
private static final long serialVersionUID = 1L;
/** The protocol classname. */
private String protocolClassname;
- /** The event is a client protocol. */
- private boolean isClientProtocol; /* true = client, false = server */
+ /** The event is a client protocol if true. Else it is a server protocol */
+ private boolean isClientProtocol;
- /** The event is a protocol activation. */
- private boolean isProtocolActivation; /* true = activate, false = deactivate */
+ /** The event is a protocol activation if true. Else it is a deactivation */
+ private boolean isProtocolActivation;
/* (non-Javadoc)
* @see events.VSAbstractEvent#onInit()
@@ -30,36 +37,40 @@ public class VSProtocolEvent extends VSAbstractEvent {
}
/**
- * Checks if is client protocol.
+ * Sets if it is a client protocol activation/deactivation.
*
- * @param isClientProtocol the is client protocol
+ * @param isClientProtocol the event is client protocol if true. the event
+ * is a server protocol if false.
*/
public void isClientProtocol(boolean isClientProtocol) {
this.isClientProtocol = isClientProtocol;
}
/**
- * Checks if is client protocol.
+ * Checks if it is a client protocol activation/deactivation.
*
- * @return true, if is client protocol
+ * @return the event is client protocol if true. the event
+ * is a server protocol if false.
*/
public boolean isClientProtocol() {
return isClientProtocol;
}
/**
- * Checks if is protocol activation.
+ * Sets if it is protocol activation.
*
- * @param isProtocolActivation the is protocol activation
+ * @param isProtocolActivation true, if it is a protocol activation. false,
+ * if it is a protocol deactivation.
*/
public void isProtocolActivation(boolean isProtocolActivation) {
this.isProtocolActivation = isProtocolActivation;
}
/**
- * Checks if is protocol activation.
+ * Checks if it is protocol activation.
*
- * @return true, if is protocol activation
+ * @return true, if it is a protocol activation. false, if it is a protocol
+ * deactivation.
*/
public boolean isProtocolActivation() {
return isProtocolActivation;
@@ -78,12 +89,11 @@ public class VSProtocolEvent extends VSAbstractEvent {
* @see events.VSAbstractEvent#onStart()
*/
public boolean onStart() {
- VSAbstractProtocol protocol = process.getProtocolObject(
- protocolClassname);
+ VSAbstractProtocol protocol =
+ process.getProtocolObject(protocolClassname);
if (isClientProtocol)
protocol.isClient(isProtocolActivation);
-
else
protocol.isServer(isProtocolActivation);