1 /**
2 * Copyright 2006 Matthew Purland (m.purland@gmail.com)
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
17 package net.sf.mud4j.effect;
18
19 /**
20 * Effect to provide addon effects for specific objects.
21 *
22 * @todo use decorator pattern with effects with characters and items and others
23 *
24 * @author Matthew Purland
25 */
26 public interface Effect {
27
28 /**
29 * Apply effect on the target.
30 * @param target Target object to apply effect on.
31 */
32 public void apply() throws EffectException;
33
34 /**
35 * Undo the effect from the target.
36 * @param target Target object to remove effect from.
37 */
38 public void undo() throws EffectException;
39
40 /**
41 * Determine if the effect has expired duration.
42 * @return Returns whether the effect has expired yet.
43 */
44 public boolean hasExpired();
45
46 /**
47 * Determine if the effect is permanent. Permanent status means
48 * that the effect cannot be removed.
49 */
50 public boolean isPermanent();
51
52 /**
53 * Get name of the effect
54 */
55 public String getName();
56 }