org.eclipse.linuxtools.tmf/src/org/eclipse/linuxtools/tmf/trace/TmfContext.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Francois Chouinard - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.trace;
  14
  15
  16 /**
  17  * <b><u>TmfContext</u></b>
  18  * <p>
  19  * Trace context structure. It ties a trace location to an event rank. The
  20  * context should be enough to restore the trace state so the corresponding
  21  * event can be read.
  22  */
  23 public class TmfContext implements ITmfContext, Cloneable {
  24
  25         private ITmfLocation<?> fLocation;
  26         private long fRank;
  27
  28         // ------------------------------------------------------------------------
  29         // Constructors
  30         // ------------------------------------------------------------------------
  31
  32         public TmfContext(ITmfLocation<?> loc, long rank) {
  33                 fLocation = loc;
  34                 fRank = rank;
  35         }
  36
  37         public TmfContext(ITmfLocation<?> location) {
  38                 this(location, UNKNOWN_RANK);
  39         }
  40
  41         public TmfContext(TmfContext other) {
  42                 this(other.fLocation, other.fRank);
  43         }
  44
  45         public TmfContext() {
  46                 this(null, UNKNOWN_RANK);
  47         }
  48
  49         // ------------------------------------------------------------------------
  50         // ITmfContext
  51         // ------------------------------------------------------------------------
  52
  53         @Override
  54         public void setLocation(ITmfLocation<?> location) {
  55                 fLocation = location;
  56         }
  57
  58         @Override
  59         public ITmfLocation<?> getLocation() {
  60                 return fLocation;
  61         }
  62
  63         @Override
  64         public void setRank(long rank) {
  65                 fRank = rank;
  66         }
  67
  68         @Override
  69         public long getRank() {
  70                 return fRank;
  71         }
  72
  73         @Override
  74         public void updateRank(int delta) {
  75                 if (isValidRank())
  76                         fRank += delta;
  77         }
  78
  79         @Override
  80         public boolean isValidRank() {
  81                 return fRank != UNKNOWN_RANK;
  82         }
  83
  84         // ------------------------------------------------------------------------
  85         // Object
  86         // ------------------------------------------------------------------------
  87
  88     @Override
  89     public int hashCode() {
  90                 int result = 17;
  91                 result = 37 * result + fLocation.hashCode();
  92                 result = 37 * result + (int) (fRank ^ (fRank >>> 32));
  93         return result;
  94     }
  95
  96     @Override
  97     public boolean equals(Object other) {
  98         if (other == this) {
  99                 return true;
 100         }
 101         if (!(other instanceof TmfContext)) {
 102                 return false;
 103         }
 104         TmfContext o = (TmfContext) other;
 105         return fLocation.equals(o.fLocation) && (fRank == o.fRank);
 106     }
 107
 108     @Override
 109     public String toString() {
 110         return "[TmfContext(" + fLocation.toString() +  "," + fRank + ")]";
 111     }
 112
 113         @Override
 114         public TmfContext clone() {
 115                 TmfContext clone = null;
 116                 try {
 117                         clone = (TmfContext) super.clone();
 118                         clone.fLocation = fLocation.clone();
 119                         clone.fRank = fRank;
 120                 } catch (CloneNotSupportedException e) {
 121                 }
 122                 return clone;
 123         }
 124
 125 }