Aspectalizable


1   /*
2    * Copyright 1999-2002,2004 The Apache Software Foundation.
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  package org.apache.cocoon.portal.aspect;
17  
18  import java.util.Map  ;
19  
20  
21  /**
22   * This interface marks an object that can be used by aspects.
23   * An aspect can store any arbitrary information in an aspectalizable object.
24   * 
25   * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
26   * @author <a HREF="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
27   * 
28   * @version CVS $Id: Aspectalizable.java 30932 2004-07-29 17:35:38Z vgritsenko $
29   */
30  public interface Aspectalizable {
31  
32      /**
33       * Get the data associated with an aspect
34       * @param aspectName The aspect name
35       * @return The data or null if the aspect is not associated with this object
36       */
37      Object   getAspectData(String   aspectName);
38      
39      /**
40       * Set the data associated with an aspect
41       * The data is only set if the object is associated with the given aspect
42       * @param aspectName The aspect name
43       * @param data The data
44       */
45      void setAspectData(String   aspectName, Object   data);
46      
47      /**
48       * Return all aspect datas 
49       * @return A map of data objects, the keys are built by the aspect names
50       */
51      Map   getAspectDatas();
52      
53      /**
54       * Return all persistent aspect datas 
55       * @return A map of data objects, the keys are built by the aspect names
56       */
57      Map   getPersistentAspectData();
58  
59      void addPersistentAspectData(String   aspectName, Object   data);
60      
61      /**
62       * Is this aspect supported
63       */
64      boolean isAspectSupported(String   aspectName);
65  
66      /**
67       * This method is invoked once to set the handler
68       */
69      void setAspectDataHandler(AspectDataHandler handler);
70  }
71
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags