org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/ctfadaptor/CtfLocation.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are made
   5  * 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: Matthew Khouzam - Initial API and implementation
  10  *******************************************************************************/
  11 package org.eclipse.linuxtools.tmf.core.ctfadaptor;
  12
  13 import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
  14 import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation;
  15
  16 /**
  17  * The nugget of information that is unique to a location in a CTF trace.
  18  *
  19  * It can be copied and used to restore a position in a given trace.
  20  *
  21  * @version 1.0
  22  * @author Matthew Khouzam
  23  */
  24 public class CtfLocation implements ITmfLocation, Cloneable {
  25
  26     private CtfLocationData fLocation;
  27
  28     /**
  29      * An invalid location
  30      */
  31     public static final CtfLocationData INVALID_LOCATION = new CtfLocationData(-1, -1);
  32
  33     /**
  34      * Constructor for CtfLocation. Uses a default index of 0.
  35      *
  36      * @param timestamp
  37      *            The timestamp of this location
  38      */
  39     public CtfLocation(ITmfTimestamp timestamp) {
  40         setLocation(new CtfLocationData(timestamp.getValue(), 0));
  41     }
  42
  43     /**
  44      * Standard constructor
  45      *
  46      * @param timestamp
  47      *            The timestamp of this location
  48      * @param index
  49      *            The index of this location for this timestamp
  50      * @since 2.0
  51      */
  52     public CtfLocation(ITmfTimestamp timestamp, long index) {
  53         setLocation(new CtfLocationData(timestamp.getValue(), index));
  54     }
  55
  56     /**
  57      * Copy constructor
  58      *
  59      * @param location
  60      *            Other location to copy
  61      * @since 2.0
  62      */
  63     public CtfLocation(CtfLocationData location) {
  64         setLocation(location);
  65     }
  66
  67     /**
  68      * Move this location to another location's position.
  69      *
  70      * @param location
  71      *            The location to seek to
  72      * @since 2.0
  73      */
  74     public void setLocation(CtfLocationData location) {
  75         this.fLocation = location;
  76     }
  77
  78     /**
  79      * Change this location's timestamp and index values.
  80      *
  81      * @param timestampValue
  82      *            The new timestamp
  83      * @param index
  84      *            The new index
  85      * @since 2.0
  86      */
  87     public void setLocation(long timestampValue, long index) {
  88        this.fLocation = new CtfLocationData(timestampValue, index);
  89     }
  90
  91
  92     /**
  93      * Get the Location Data of this location
  94      *
  95      * @return The CtfLocationData
  96      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfLocation#getLocationInfo()
  97      * @since 2.0
  98      */
  99     @Override
 100     public CtfLocationData getLocationInfo() {
 101         return fLocation;
 102     }
 103
 104     @Override
 105     public CtfLocation clone() {
 106         return new CtfLocation(new CtfLocationData(fLocation.getTimestamp(), fLocation.getIndex()));
 107     }
 108
 109
 110     /* (non-Javadoc)
 111      * @see java.lang.Object#hashCode()
 112      */
 113     @Override
 114     public int hashCode() {
 115         final int prime = 31;
 116         int result = 1;
 117         result = (prime * result)
 118                 + ((fLocation == null) ? 0 : fLocation.hashCode());
 119         return result;
 120     }
 121
 122     /* (non-Javadoc)
 123      * @see java.lang.Object#equals(java.lang.Object)
 124      */
 125     @Override
 126     public boolean equals(Object obj) {
 127         if (this == obj) {
 128             return true;
 129         }
 130         if (obj == null) {
 131             return false;
 132         }
 133         if (!(obj instanceof CtfLocation)) {
 134             return false;
 135         }
 136         CtfLocation other = (CtfLocation) obj;
 137         if (fLocation == null) {
 138             if (other.fLocation != null) {
 139                 return false;
 140             }
 141         } else if (!fLocation.equals(other.fLocation)) {
 142             return false;
 143         }
 144         return true;
 145     }
 146
 147     /* (non-Javadoc)
 148      * @see java.lang.Object#toString()
 149      */
 150     @Override
 151     public String toString() {
 152         if( this.getLocationInfo().equals(CtfLocation.INVALID_LOCATION )) {
 153             return "CtfLocation: INVALID"; //$NON-NLS-1$
 154         }
 155         return "CtfLocation: " + getLocationInfo().toString(); //$NON-NLS-1$
 156     }
 157
 158
 159 }