org.expasy.mzjava.core.ms.spectrum

Class RetentionTimeInterval

java.lang.Object

org.expasy.mzjava.core.ms.spectrum.RetentionTimeInterval

All Implemented Interfaces:

RetentionTime

public class RetentionTimeInterval
extends Object
implements RetentionTime

A retention time that stores a time interval. The getTime method returns the time in the middle of the interval. All times are stored in seconds

Version:

1.0

Author:

Oliver Horlacher

Constructor Summary

Constructors

Constructor and Description
RetentionTimeInterval(double startTime, double endTime, TimeUnit unit) Constructor for a RetentionTimeInterval from startTime to endTime.
RetentionTimeInterval(RetentionTimeInterval src) Copy constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(RetentionTime retentionTime)
RetentionTimeInterval	copy()
boolean	equals(Object o)
double	getMaxRetentionTime() Returns the largest retention time, the units of the time is seconds
double	getMinRetentionTime() Returns the smallest retention time, the units of the time is seconds
double	getTime() Returns the time in the middle of the interval in seconds
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetentionTimeInterval

public RetentionTimeInterval(double startTime,
                     double endTime,
                     TimeUnit unit)

Constructor for a RetentionTimeInterval from startTime to endTime. Both times are converted to seconds

Parameters:

startTime - the start time

endTime - the end time

unit - the time unit for startTime and endTime

RetentionTimeInterval

public RetentionTimeInterval(RetentionTimeInterval src)

Copy constructor

Parameters:

src - the RetentionTime to copy

Method Detail

getTime

public double getTime()

Returns the time in the middle of the interval in seconds

Specified by:

getTime in interface RetentionTime

Returns:

the time in the middle of the interval in seconds

getMinRetentionTime

public double getMinRetentionTime()

Description copied from interface: RetentionTime

Returns the smallest retention time, the units of the time is seconds

Specified by:

getMinRetentionTime in interface RetentionTime

Returns:

the smallest retention time, the units of the time is seconds

getMaxRetentionTime

public double getMaxRetentionTime()

Description copied from interface: RetentionTime

Returns the largest retention time, the units of the time is seconds

Specified by:

getMaxRetentionTime in interface RetentionTime

Returns:

the largest retention time, the units of the time is seconds

copy

public RetentionTimeInterval copy()

Specified by:

copy in interface RetentionTime

contains

public boolean contains(RetentionTime retentionTime)

Specified by:

contains in interface RetentionTime

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object