01: /*
02: * Copyright (c) 2001-2006 JGoodies Karsten Lentzsch. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
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.1 $
39: *
40: * @see AnimationFunctions
41: */
42:
43: public abstract class AbstractAnimationFunction implements
44: AnimationFunction {
45:
46: /**
47: * Describes this animation function's duration.
48: */
49: private final long duration;
50:
51: // Instance Creation ******************************************************
52:
53: /**
54: * Constructs an <code>AbstractAnimationFunction</code> using the given
55: * duration.
56: *
57: * @param duration the function's duration
58: * @throws IllegalArgumentException if the duration is negative
59: */
60: protected AbstractAnimationFunction(long duration) {
61: if (duration < 0)
62: throw new IllegalArgumentException(
63: "The duration must not be negative.");
64:
65: this .duration = duration;
66: }
67:
68: // ************************************************************************
69:
70: /**
71: * Checks whether the given time is in the valid time range, that is
72: * a non-negative time that is smaller than this function's duration.
73: * If not, an <code>IllegalArgumentException</code> is thrown.
74: *
75: * @param time the time to be checked
76: * @throws IllegalArgumentException if the time is outside the valid time
77: * range
78: */
79: protected void checkTimeRange(long time) {
80: if ((time < 0) || (time >= duration()))
81: throw new IllegalArgumentException(
82: "The time must be larger than 0 and smaller than "
83: + duration() + ".");
84: }
85:
86: /**
87: * Returns this animation function's duration.
88: *
89: * @return this animation function's duration
90: */
91: public final long duration() {
92: return duration;
93: }
94:
95: }
|