View Javadoc

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   * Abstract implementation for effects.
21   * 
22   * @author Matthew Purland
23   */
24  public abstract class AbstractEffect implements Effect {
25  
26      // Name of the effect
27      private String effectName;
28      
29      public AbstractEffect() {
30          this("");
31      }
32      
33      public AbstractEffect(String effectName) {
34          this.effectName = effectName;
35      }
36  
37      /**
38       * {@inheritDoc}
39       */
40      public String getName() {
41          return effectName;
42      }
43  
44      /**
45       * {@inheritDoc}
46       */
47      public boolean hasExpired() {
48          // TODO do effect expiration
49          return false;
50      }
51  
52      /**
53       * {@inheritDoc}
54       */
55      abstract public void undo() throws EffectException;
56      
57      /**
58       * {@inheritDoc}
59       */
60      abstract public void apply() throws EffectException;
61  }