X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=org.eclipse.linuxtools.tmf.core%2Fsrc%2Forg%2Feclipse%2Flinuxtools%2Ftmf%2Fcore%2Ftrace%2FITmfContext.java;h=f3b526e117e2771fcc5eaea1cadaaadf3ba175a4;hb=0d3a54a39afe440c6521ffa3caf6cda7aa2a2c9f;hp=2d7aed53660aa126178d8ab057bcc5dc29299eca;hpb=20f27c02913b3cbb73aa3ac0998e3313ae6ec234;p=deliverable%2Ftracecompass.git diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java index 2d7aed5366..f3b526e117 100644 --- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java +++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java @@ -1,61 +1,64 @@ /******************************************************************************* - * Copyright (c) 2009, 2010, 2012 Ericsson - * + * Copyright (c) 2009, 2013 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 * Francois Chouinard - Updated as per TMF Trace Model 1.0 + * Patrick Tasse - Updated for removal of context clone *******************************************************************************/ package org.eclipse.linuxtools.tmf.core.trace; +import org.eclipse.linuxtools.tmf.core.trace.location.ITmfLocation; + /** - * ITmfContext - *

* The basic trace context structure in TMF. The purpose of the context is to - * associate a trace location to an event of a specific rank (order). + * associate a trace location to an event at a specific rank (order). *

* The context should be sufficient to allow the trace to position itself so - * that performing a trace read operation will yield the corresponding event. + * that performing a trace read operation will yield the corresponding 'nth' + * event. + * + * @version 1.0 + * @author Francois Chouinard + * + * @see ITmfLocation */ -public interface ITmfContext extends Cloneable { +public interface ITmfContext { // ------------------------------------------------------------------------ // Constants // ------------------------------------------------------------------------ - /** - * The initial context event rank, before anything is read from the trace - */ - public long INITIAL_RANK = -1L; - /** * The unknown event rank */ - public long UNKNOWN_RANK = -2L; + public long UNKNOWN_RANK = -1L; // ------------------------------------------------------------------------ // Getters // ------------------------------------------------------------------------ /** - * @return the rank of the event referred to by the context + * @return the rank of the event at the context location */ - public long getRank(); + long getRank(); /** - * @return the location of the event referred to by the context + * @return the location of the event at the context rank + * @since 3.0 */ - public ITmfLocation> getLocation(); + ITmfLocation getLocation(); /** * @return indicates if the context rank is valid (!= UNKNOWN_RANK) */ - public boolean hasValidRank(); + boolean hasValidRank(); // ------------------------------------------------------------------------ // Operations @@ -63,31 +66,23 @@ public interface ITmfContext extends Cloneable { /** * @param location the new location + * @since 3.0 */ - public void setLocation(ITmfLocation> location); + void setLocation(ITmfLocation location); /** * @param rank the new rank */ - public void setRank(long rank); + void setRank(long rank); /** * Increment the context rank */ - public void increaseRank(); + void increaseRank(); /** * Cleanup hook */ - public void dispose(); - - // ------------------------------------------------------------------------ - // Cloneable - // ------------------------------------------------------------------------ - - /** - * @return a clone of the context - */ - public ITmfContext clone(); + void dispose(); }