View Javadoc

1   /*
2    *  Copyright 2001-2005 Stephen Colebourne
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
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  /**
19   * DurationConverter defines how an object is converted to a millisecond duration.
20   *
21   * @author Stephen Colebourne
22   * @author Brian S O'Neill
23   * @since 1.0
24   */
25  public interface DurationConverter extends Converter {
26  
27      /**
28       * Extracts the millis from an object of this convertor's type.
29       * 
30       * @param object  the object to convert, must not be null
31       * @return the millisecond duration
32       * @throws ClassCastException if the object is invalid
33       */
34      long getDurationMillis(Object object);
35  
36  }