requirements: Implement all level for event names and fields

[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.core / src / org / eclipse / tracecompass / tmf / core / trace / text / TextTraceEvent.java

/*******************************************************************************
 * Copyright (c) 2014 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:
 *   Alexandre Montplaisir - Initial API and implementation
 *******************************************************************************/

package org.eclipse.tracecompass.tmf.core.trace.text;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.tracecompass.tmf.core.event.ITmfEventType;
import org.eclipse.tracecompass.tmf.core.event.TmfEvent;
import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
import org.eclipse.tracecompass.tmf.core.trace.ITmfContext;

/**
 * Class to store the common functionality of text trace events.
 *
 * @author Alexandre Montplaisir
 */
public abstract class TextTraceEvent extends TmfEvent {

    /**
     * Full Constructor.
     *
     * Compared to {@link TmfEvent}'s constructor, 'content' is restricted to a
     * {@link TextTraceEventContent}.
     *
     * @param parentTrace
     *            The parent trace
     * @param timestamp
     *            The event timestamp
     * @param type
     *            The event type
     * @param content
     *            The event content (payload)
     */
    public TextTraceEvent(TextTrace<? extends TextTraceEvent> parentTrace,
            final ITmfTimestamp timestamp,
            final ITmfEventType type,
            final TextTraceEventContent content) {
        super(parentTrace, ITmfContext.UNKNOWN_RANK, timestamp, type, content);
    }

    /**
     * Copy constructor
     *
     * @param other
     *            The event to copy
     */
    public TextTraceEvent(final @NonNull TextTraceEvent other) {
        super(other);
    }

    @Override
    public TextTrace<? extends TextTraceEvent> getTrace() {
        /* Cast should be safe, type is restricted by the constructor */
        return (TextTrace<?>) super.getTrace();
    }

    @Override
    public TextTraceEventContent getContent() {
        /* Cast should be safe, type is restricted by the constructor */
        return (TextTraceEventContent) super.getContent();
    }
}