package org.eclipse.linuxtools.tmf.core.uml2sd;
import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
-import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
/**
- * <b><u>TmfSyncSequenceDiagramEvent</u></b>
* <p>
- * Sample implementation of the ITmfSyncSequenceDiagramEvent
+ * A basic implementation of ITmfSyncSequenceDiagramEvent.
* </p>
+ *
+ * @version 1.0
+ * @author Bernd Hufmann
*/
public class TmfSyncSequenceDiagramEvent implements ITmfSyncSequenceDiagramEvent {
// ------------------------------------------------------------------------
// Attributes
// ------------------------------------------------------------------------
+ /**
+ * The start time of the sequence diagram event (i.e. time when signal was sent).
+ */
final protected ITmfTimestamp fStartTime;
+ /**
+ * The name of the sender of the signal.
+ */
final protected String fSender;
+ /**
+ * The name of the receiver of the signal.
+ */
final protected String fReceiver;
+ /**
+ * The name of the signal
+ */
final protected String fName;
// ------------------------------------------------------------------------
// Constructors
- // ------------------------------------------------------------------------
+ // ------------------------------------------------------------------------
+ /**
+ * Constructor
+ *
+ * @param startEvent The start event (on sender side).
+ * @param sender The name of sender of signal.
+ * @param receiver The Name of receiver of signal.
+ * @param name - The signal name
+ */
public TmfSyncSequenceDiagramEvent(ITmfEvent startEvent, String sender, String receiver, String name) {
if ((startEvent == null) || (sender == null) || (receiver == null) || (name == null)) {
(name == null ? ", name=null" : "")); //$NON-NLS-1$ //$NON-NLS-2$
}
- fStartTime = startEvent.getTimestamp().clone();
+ fStartTime = startEvent.getTimestamp();
fSender = sender;
fReceiver = receiver;
// ------------------------------------------------------------------------
/*
* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.uml2sd.ITmfSyncSequenceDiagramEvent#getSender()
+ * @see org.eclipse.linuxtools.tmf.core.uml2sd.ITmfSyncSequenceDiagramEvent#getSender()
*/
@Override
public String getSender() {
/*
* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.uml2sd.ITmfSyncSequenceDiagramEvent#getReceiver()
+ * @see org.eclipse.linuxtools.tmf.core.uml2sd.ITmfSyncSequenceDiagramEvent#getReceiver()
*/
@Override
public String getReceiver() {
/*
* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.uml2sd.ITmfSyncSequenceDiagramEvent#getName()
+ * @see org.eclipse.linuxtools.tmf.core.uml2sd.ITmfSyncSequenceDiagramEvent#getName()
*/
@Override
public String getName() {
return fName;
}
- /*
- * (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.uml2sd.ITmfSyncSequenceDiagramEvent#getStartTime()
+ /**
+ * @since 2.0
*/
@Override
public ITmfTimestamp getStartTime() {