01: /*
02: * Copyright 2001-2005 Stephen Colebourne
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.joda.time.convert;
17:
18: import org.joda.time.Chronology;
19: import org.joda.time.PeriodType;
20: import org.joda.time.ReadWritablePeriod;
21:
22: /**
23: * PeriodConverter defines how an object is converted to a time period.
24: *
25: * @author Stephen Colebourne
26: * @author Brian S O'Neill
27: * @since 1.0
28: */
29: public interface PeriodConverter extends Converter {
30:
31: /**
32: * Extracts duration values from an object of this converter's type, and
33: * sets them into the given ReadWritableDuration.
34: *
35: * @param period the period to modify
36: * @param object the object to convert, must not be null
37: * @param chrono the chronology to use, must not be null
38: * @throws ClassCastException if the object is invalid
39: */
40: void setInto(ReadWritablePeriod period, Object object,
41: Chronology chrono);
42:
43: /**
44: * Selects a suitable period type for the given object.
45: *
46: * @param object the object to examine, must not be null
47: * @return the period type, never null
48: * @throws ClassCastException if the object is invalid
49: */
50: PeriodType getPeriodType(Object object);
51:
52: }
|