tmf: Add an ID to each state system that gets built

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / signal / TmfStateSystemBuildCompleted.java

/*******************************************************************************
 * Copyright (c) 2012 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:
 *   Francois Chouinard - Initial API and implementation
 *******************************************************************************/

package org.eclipse.linuxtools.tmf.core.signal;

import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;

/**
 * Signal sent when the state system has completed its build.
 *
 * @version 1.0
 * @author Francois Chouinard
 */
public class TmfStateSystemBuildCompleted extends TmfSignal {

    private final ITmfTrace fTrace;
    private final String fID;

    /**
     * Constructor
     *
     * @param source
     *            Object sending this signal
     * @param trace
     *            The state system of which trace just finished building
     * @param id
     *            ID associated with this state system. This can be used in the
     *            case of a trace containing multiple state systems, to
     *            differentiate between them.
     * @since 2.0
     */
    public TmfStateSystemBuildCompleted(Object source, ITmfTrace trace, String id) {
        super(source);
        fTrace = trace;
        fID = id;
    }

    /**
     * @return The trace referred to by this signal
     */
    public ITmfTrace getTrace() {
        return fTrace;
    }

    /**
     * @return The ID of the state system that just finished building
     * @since 2.0
     */
    public String getID() {
        return fID;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return "[TmfStateSystemBuildCompleted (trace = " + fTrace.toString() + //$NON-NLS-1$
                ", ID = " + fID + ")]"; //$NON-NLS-1$ //$NON-NLS-2$
    }

}