com.groupbyinc.common.joda.time.field.DecoratedDurationField Maven / Gradle / Ivy
/*
* Copyright 2001-2005 Stephen Colebourne
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.joda.time.field;
import org.joda.time.DurationField;
import org.joda.time.DurationFieldType;
/**
* DecoratedDurationField extends {@link BaseDurationField},
* implementing only the minimum required set of methods. These implemented
* methods delegate to a wrapped field.
*
* This design allows new DurationField types to be defined that piggyback on
* top of another, inheriting all the safe method implementations from
* BaseDurationField. Should any method require pure delegation to the
* wrapped field, simply override and use the provided getWrappedField method.
*
* DecoratedDurationField is thread-safe and immutable, and its subclasses must
* be as well.
*
* @author Brian S O'Neill
* @see DelegatedDurationField
* @since 1.0
*/
public class DecoratedDurationField extends BaseDurationField {
private static final long serialVersionUID = 8019982251647420015L;
/** The DurationField being wrapped */
private final DurationField iField;
/**
* Constructor.
*
* @param field the base field
* @param type the type to actually use
*/
public DecoratedDurationField(DurationField field, DurationFieldType type) {
super(type);
if (field == null) {
throw new IllegalArgumentException("The field must not be null");
}
if (!field.isSupported()) {
throw new IllegalArgumentException("The field must be supported");
}
iField = field;
}
//-----------------------------------------------------------------------
/**
* Gets the wrapped duration field.
*
* @return the wrapped DurationField
*/
public final DurationField getWrappedField() {
return iField;
}
public boolean isPrecise() {
return iField.isPrecise();
}
public long getValueAsLong(long duration, long instant) {
return iField.getValueAsLong(duration, instant);
}
public long getMillis(int value, long instant) {
return iField.getMillis(value, instant);
}
public long getMillis(long value, long instant) {
return iField.getMillis(value, instant);
}
public long add(long instant, int value) {
return iField.add(instant, value);
}
public long add(long instant, long value) {
return iField.add(instant, value);
}
public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant) {
return iField.getDifferenceAsLong(minuendInstant, subtrahendInstant);
}
public long getUnitMillis() {
return iField.getUnitMillis();
}
}