Commit | Line | Data |
---|---|---|
8c8bf09f ASL |
1 | /******************************************************************************* |
2 | * Copyright (c) 2009 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.event; | |
14 | ||
15 | /** | |
16 | * <b><u>TmfTimeRange</u></b> | |
17 | * <p> | |
18 | * A utility class to define time ranges. | |
19 | */ | |
20 | public class TmfTimeRange { | |
21 | ||
22 | // ------------------------------------------------------------------------ | |
23 | // Constants | |
24 | // ------------------------------------------------------------------------ | |
25 | ||
26 | public static final TmfTimeRange Eternity = new TmfTimeRange(TmfTimestamp.BigBang, TmfTimestamp.BigCrunch); | |
27 | ||
28 | // ------------------------------------------------------------------------ | |
29 | // Attributes | |
30 | // ------------------------------------------------------------------------ | |
31 | ||
32 | private final TmfTimestamp fStartTime; | |
33 | private final TmfTimestamp fEndTime; | |
34 | ||
35 | // ------------------------------------------------------------------------ | |
36 | // Constructors | |
37 | // ------------------------------------------------------------------------ | |
38 | ||
39 | @SuppressWarnings("unused") | |
40 | private TmfTimeRange() { | |
41 | throw new AssertionError(); | |
42 | } | |
43 | ||
44 | /** | |
45 | * @param startTime | |
46 | * @param endTime | |
47 | */ | |
48 | public TmfTimeRange(TmfTimestamp startTime, TmfTimestamp endTime) { | |
49 | if (startTime == null || endTime == null) { | |
50 | throw new IllegalArgumentException(); | |
51 | } | |
52 | fStartTime = new TmfTimestamp(startTime); | |
53 | fEndTime = new TmfTimestamp(endTime); | |
54 | } | |
55 | ||
56 | /** | |
57 | * Copy constructor | |
58 | * @param other | |
59 | */ | |
60 | public TmfTimeRange(TmfTimeRange other) { | |
61 | if (other == null) { | |
62 | throw new IllegalArgumentException(); | |
63 | } | |
64 | fStartTime = new TmfTimestamp(other.fStartTime); | |
65 | fEndTime = new TmfTimestamp(other.fEndTime); | |
66 | } | |
67 | ||
68 | // ------------------------------------------------------------------------ | |
69 | // Accessors | |
70 | // ------------------------------------------------------------------------ | |
71 | ||
72 | /** | |
73 | * @return The time range start time | |
74 | */ | |
75 | public TmfTimestamp getStartTime() { | |
76 | return new TmfTimestamp(fStartTime); | |
77 | } | |
78 | ||
79 | /** | |
80 | * @return The time range end time | |
81 | */ | |
82 | public TmfTimestamp getEndTime() { | |
83 | return new TmfTimestamp(fEndTime); | |
84 | } | |
85 | ||
86 | // ------------------------------------------------------------------------ | |
87 | // Predicates | |
88 | // ------------------------------------------------------------------------ | |
89 | ||
90 | /** | |
91 | * Check if the timestamp is within the time range | |
92 | * | |
93 | * @param ts | |
94 | * @return | |
95 | */ | |
96 | public boolean contains(TmfTimestamp ts) { | |
97 | return (fStartTime.compareTo(ts, true) <= 0) && (fEndTime.compareTo(ts, true) >= 0); | |
98 | } | |
99 | ||
100 | // ------------------------------------------------------------------------ | |
101 | // Object | |
102 | // ------------------------------------------------------------------------ | |
103 | ||
104 | @Override | |
105 | public int hashCode() { | |
106 | int result = 17; | |
107 | result = 37 * result + fStartTime.hashCode(); | |
108 | result = 37 * result + fEndTime.hashCode(); | |
109 | return result; | |
110 | } | |
111 | ||
112 | @Override | |
113 | public boolean equals(Object other) { | |
114 | if (!(other instanceof TmfTimeRange)) | |
115 | return false; | |
116 | TmfTimeRange range = (TmfTimeRange) other; | |
117 | return range.fStartTime.equals(fStartTime) && range.fEndTime.equals(fEndTime); | |
118 | } | |
119 | ||
120 | @Override | |
121 | public String toString() { | |
122 | return "[TmfTimeRange(" + fStartTime + ":" + fEndTime + ")]"; | |
123 | } | |
124 | ||
125 | } |