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 import java.util.List;
20
21 /**
22 * Effect behavior to decouple the behavior of managing effects from
23 * the objects that have effects {@link Effectable} so that the objects
24 * that implement the interface will only have to worry about
25 * providing a way to retrieve an {@link EffectBehavior}
26 *
27 * @author Matthew Purland
28 */
29 public interface EffectBehavior {
30
31 /**
32 * Get list of effects.
33 *
34 * @return Returns a list of effects.
35 */
36 public List<Effect> getEffects();
37
38 /**
39 * Add effect to behavior object.
40 *
41 * @param effect Effect to add.
42 * @throws EffectException in case adding an effect will not be possible.
43 */
44 public void addEffect(Effect effect) throws EffectException;
45
46 /**
47 * Remove effect from behavior object.
48 *
49 * @param effect Effect to remove.
50 * @throws EffectException in case removing an effect will not be possible.
51 */
52 public void removeEffect(Effect effect) throws EffectException;
53
54 /**
55 * Clear all effects.
56 */
57 public void clear();
58 }