KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jgoodies > animation > AbstractAnimationFunction


1 /*
2  * Copyright (c) 2001-2004 JGoodies Karsten Lentzsch. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * o Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * o Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * o Neither the name of JGoodies Karsten Lentzsch nor the names of
15  * its contributors may be used to endorse or promote products derived
16  * from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 package com.jgoodies.animation;
32
33 /**
34  * An abstract class that minimizes the effort required to implement
35  * the {@link AnimationFunction} interface.
36  *
37  * @author Karsten Lentzsch
38  * @version $Revision: 1.2 $
39  *
40  * @see AnimationFunctions
41  */
42
43 public abstract class AbstractAnimationFunction
44     implements AnimationFunction {
45     
46     /**
47      * Describes this animation function's duration.
48      */
49     private final long duration;
50     
51     
52     // Instance Creation ******************************************************
53
54     /**
55      * Constructs an <code>AbstractAnimationFunction</code> using the given
56      * duration.
57      *
58      * @param duration the function's duration
59      * @throws IllegalArgumentException if the duration is negative
60      */
61     protected AbstractAnimationFunction(long duration) {
62         if (duration < 0)
63             throw new IllegalArgumentException JavaDoc("The duration must not be negative.");
64
65         this.duration = duration;
66     }
67
68     
69     // ************************************************************************
70
71     /**
72      * Checks whether the given time is in the valid time range, that is
73      * a non-negative time that is smaller than this function's duration.
74      * If not, an <code>IllegalArgumentException</code> is thrown.
75      *
76      * @param time the time to be checked
77      * @throws IllegalArgumentException if the time is outside the valid time
78      * range
79      */
80     protected void checkTimeRange(long time) {
81         if ((time < 0) || (time >= duration()))
82             throw new IllegalArgumentException JavaDoc(
83                 "The time must be larger than 0 and smaller than "
84                     + duration()
85                     + ".");
86     }
87
88     
89     /**
90      * Returns this animation function's duration.
91      *
92      * @return this animation function's duration
93      */
94     public final long duration() {
95         return duration;
96     }
97
98 }
Popular Tags