import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation;
/**
- * The ctflocation is the nugget of information that is unique to a location in a trace.
- * it can be copied and used to restore a position in a given trace.
+ * The nugget of information that is unique to a location in a CTF trace.
+ *
+ * It can be copied and used to restore a position in a given trace.
+ *
+ * @version 1.0
+ * @author Matthew Khouzam
*/
-public class CtfLocation implements ITmfLocation<Long> {
+public class CtfLocation implements ITmfLocation<CtfLocationData>, Cloneable {
- public static final Long INVALID_LOCATION = -1L;
+ private CtfLocationData fLocation;
/**
- * Constructor for CtfLocation.
- * @param location Long
+ * An invalid location
*/
- public CtfLocation(Long location) {
- setLocation(location);
- }
+ public static final CtfLocationData INVALID_LOCATION = new CtfLocationData(-1, -1);
/**
- * Constructor for CtfLocation.
- * @param timestamp ITmfTimestamp
+ * Constructor for CtfLocation. Uses a default index of 0.
+ *
+ * @param timestamp
+ * The timestamp of this location
*/
public CtfLocation(ITmfTimestamp timestamp) {
- setLocation(timestamp.getValue());
+ setLocation(new CtfLocationData(timestamp.getValue(), 0));
}
- private Long fTimestamp;
+ /**
+ * Standard constructor
+ *
+ * @param timestamp
+ * The timestamp of this location
+ * @param index
+ * The index of this location for this timestamp
+ * @since 2.0
+ */
+ public CtfLocation(ITmfTimestamp timestamp, long index) {
+ setLocation(new CtfLocationData(timestamp.getValue(), index));
+ }
/**
- * Method setLocation.
- * @param location Long
+ * Copy constructor
+ *
+ * @param location
+ * Other location to copy
+ * @since 2.0
*/
- public void setLocation(Long location) {
- this.fTimestamp = location;
+ public CtfLocation(CtfLocationData location) {
+ setLocation(location);
}
/**
- * Method getLocation.
- * @return Long
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfLocation#getLocation()
+ * Move this location to another location's position.
+ *
+ * @param location
+ * The location to seek to
+ * @since 2.0
*/
- @Override
- public Long getLocation() {
- return this.fTimestamp;
+ public void setLocation(CtfLocationData location) {
+ this.fLocation = location;
}
/**
- * Method clone.
- * @return CtfLocation
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfLocation#clone()
+ * Change this location's timestamp and index values.
+ *
+ * @param timestampValue
+ * The new timestamp
+ * @param index
+ * The new index
+ * @since 2.0
+ */
+ public void setLocation(long timestampValue, long index) {
+ this.fLocation = new CtfLocationData(timestampValue, index);
+ }
+
+
+ /**
+ * Get the Location Data of this location
+ *
+ * @return The CtfLocationData
+ * @see org.eclipse.linuxtools.tmf.core.trace.ITmfLocation#getLocationData()
+ * @since 2.0
*/
+ @Override
+ public CtfLocationData getLocationData() {
+ return fLocation;
+ }
+
@Override
public CtfLocation clone() {
- return new CtfLocation(getLocation());
+ return new CtfLocation(new CtfLocationData(fLocation.getTimestamp(), fLocation.getIndex()));
}
+
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
final int prime = 31;
int result = 1;
result = (prime * result)
- + ((fTimestamp == null) ? 0 : fTimestamp.hashCode());
+ + ((fLocation == null) ? 0 : fLocation.hashCode());
return result;
}
return false;
}
CtfLocation other = (CtfLocation) obj;
- if (fTimestamp == null) {
- if (other.fTimestamp != null) {
+ if (fLocation == null) {
+ if (other.fLocation != null) {
return false;
}
- } else if (!fTimestamp.equals(other.fTimestamp)) {
+ } else if (!fLocation.equals(other.fLocation)) {
return false;
}
return true;
*/
@Override
public String toString() {
- if( this.getLocation().equals(CtfLocation.INVALID_LOCATION )) {
+ if( this.getLocationData().equals(CtfLocation.INVALID_LOCATION )) {
return "CtfLocation: INVALID"; //$NON-NLS-1$
}
- return "CtfLocation: " + getLocation().toString(); //$NON-NLS-1$
+ return "CtfLocation: " + getLocationData().toString(); //$NON-NLS-1$
}
+
}