Java Doc and API clean up of TMF UML Sequence diagram framework

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / uml2sd / ITmfSyncSequenceDiagramEvent.java

/**********************************************************************
 * Copyright (c) 2011 Ericsson
 * 
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: 
 *   Bernd Hufmann - Initial API and implementation
 **********************************************************************/
package org.eclipse.linuxtools.tmf.core.uml2sd;

import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;

/**
 * <p>
 * Interface for synchronous sequence diagram events. 
 * </p>
 * 
 * @version 1.0
 * @author Bernd Hufmann
 */
public interface ITmfSyncSequenceDiagramEvent {
    
    /**
     * Returns Name of message.
     * 
     * @return Name of message
     */
    public String getName();
    
    /**
     * Returns name of sender of message.
     * 
     * @return name of sender of message
     */
    public String getSender();
    
    /**
     * Returns Name of receiver of message.
     * 
     * @return Name of receiver of message
     */
    public String getReceiver();

    /**
     * Returns Start time of message (i.e. send time).
     * 
     * @return Start timestamp of message (i.e. send time)
     */
    public ITmfTimestamp getStartTime();
}