1 /*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24 /*
25 * This file is available under and governed by the GNU General Public
26 * License version 2 only, as published by the Free Software Foundation.
27 * However, the following notice accompanied the original version of this
28 * file:
29 *
30 * Copyright (c) 2012, Stephen Colebourne & Michael Nascimento Santos
31 *
32 * All rights reserved.
33 *
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions are met:
36 *
37 * * Redistributions of source code must retain the above copyright notice,
38 * this list of conditions and the following disclaimer.
39 *
40 * * Redistributions in binary form must reproduce the above copyright notice,
41 * this list of conditions and the following disclaimer in the documentation
42 * and/or other materials provided with the distribution.
43 *
44 * * Neither the name of JSR-310 nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
49 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
50 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
51 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
52 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
53 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
54 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
55 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
56 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
57 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
58 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
59 */
60 package test.java.time;
61
62 import java.time.*;
63
64 import static java.time.temporal.ChronoUnit.DAYS;
65 import static java.time.temporal.ChronoUnit.FOREVER;
66 import static java.time.temporal.ChronoUnit.SECONDS;
67
68 import java.util.Objects;
69
70 import java.time.temporal.Temporal;
71 import java.time.temporal.TemporalAmount;
72 import java.time.temporal.TemporalAmount;
73 import java.time.temporal.TemporalUnit;
74 import java.util.List;
75
76 /**
77 * Mock period of time measured using a single unit, such as {@code 3 Days}.
78 */
79 public final class MockSimplePeriod
80 implements TemporalAmount, Comparable<MockSimplePeriod> {
81
82 /**
83 * A constant for a period of zero, measured in days.
84 */
85 public static final MockSimplePeriod ZERO_DAYS = new MockSimplePeriod(0, DAYS);
86 /**
87 * A constant for a period of zero, measured in seconds.
88 */
89 public static final MockSimplePeriod ZERO_SECONDS = new MockSimplePeriod(0, SECONDS);
90
91 /**
92 * The amount of the period.
93 */
94 private final long amount;
95 /**
96 * The unit the period is measured in.
97 */
98 private final TemporalUnit unit;
99
100 /**
101 * Obtains a {@code MockSimplePeriod} from an amount and unit.
102 * <p>
103 * The parameters represent the two parts of a phrase like '6 Days'.
104 *
105 * @param amount the amount of the period, measured in terms of the unit, positive or negative
106 * @param unit the unit that the period is measured in, must not be the 'Forever' unit, not null
107 * @return the {@code MockSimplePeriod} instance, not null
108 * @throws DateTimeException if the period unit is {@link java.time.temporal.ChronoUnit#FOREVER}.
109 */
110 public static MockSimplePeriod of(long amount, TemporalUnit unit) {
111 return new MockSimplePeriod(amount, unit);
112 }
113
114 private MockSimplePeriod(long amount, TemporalUnit unit) {
115 Objects.requireNonNull(unit, "unit");
116 if (unit == FOREVER) {
117 throw new DateTimeException("Cannot create a period of the Forever unit");
118 }
119 this.amount = amount;
120 this.unit = unit;
121 }
122
123 @Override
124 public long get(TemporalUnit unit) {
125 throw new UnsupportedOperationException("Not supported yet.");
126 }
127
128 @Override
129 public List<TemporalUnit> getUnits() {
130 throw new UnsupportedOperationException("Not supported yet.");
131 }
132
133 //-----------------------------------------------------------------------
134 public long getAmount() {
135 return amount;
136 }
137
138 public TemporalUnit getUnit() {
139 return unit;
140 }
141
142 //-------------------------------------------------------------------------
143 @Override
144 public Temporal addTo(Temporal temporal) {
145 return temporal.plus(amount, unit);
146 }
147
148 @Override
149 public Temporal subtractFrom(Temporal temporal) {
150 return temporal.minus(amount, unit);
151 }
152
153 //-----------------------------------------------------------------------
154 @Override
155 public int compareTo(MockSimplePeriod otherPeriod) {
156 if (unit.equals(otherPeriod.getUnit()) == false) {
157 throw new IllegalArgumentException("Units cannot be compared: " + unit + " and " + otherPeriod.getUnit());
158 }
159 return Long.compare(amount, otherPeriod.amount);
160 }
161
162 @Override
163 public boolean equals(Object obj) {
164 if (this == obj) {
165 return true;
166 }
167 if (obj instanceof MockSimplePeriod) {
168 MockSimplePeriod other = (MockSimplePeriod) obj;
169 return this.amount == other.amount &&
170 this.unit.equals(other.unit);
171 }
172 return false;
173 }
174
175 @Override
176 public int hashCode() {
177 return unit.hashCode() ^ (int) (amount ^ (amount >>> 32));
178 }
179
180 @Override
181 public String toString() {
182 return amount + " " + unit.getName();
183 }
184
185 }