ConfigurationTypeServiceConfiguration


1   /*
2    * The contents of this file are subject to the Sapient Public License
3    * Version 1.0 (the "License"); you may not use this file except in compliance
4    * with the License. You may obtain a copy of the License at
5    * http://carbon.sf.net/License.html.
6    *
7    * Software distributed under the License is distributed on an "AS IS" basis,
8    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9    * the specific language governing rights and limitations under the License.
10   *
11   * The Original Code is The Carbon Component Framework.
12   *
13   * The Initial Developer of the Original Code is Sapient Corporation
14   *
15   * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16   */
17  
18  package org.sape.carbon.core.config.type;
19  
20  import org.sape.carbon.core.component.ComponentConfiguration;
21  import org.sape.carbon.core.config.Configuration;
22  
23  /**
24   * <P>This is the Configuration interface that defines the configuration
25   * data for an instance of a Configuration Type Handler Service.</P>
26   *
27   * Copyright 2002 Sapient
28   * @since carbon 1.0
29   * @author Greg Hinkle, January 2002
30   * @version $Revision: 1.8 $($Author: dvoet $ / $Date: 2003/05/05 21:21:20 $)
31   */
32  public interface ConfigurationTypeServiceConfiguration
33  extends ComponentConfiguration {
34  
35      /**
36       * Retrieves the type handlers for this configuration type handler service
37       *
38       * @return an array of TypeHandlerConfiguration objects that define each
39       *   configuration type handler
40       */
41      TypeHandlerConfiguration[] getTypeHandler();
42  
43  
44      /**
45       * Sets the array of configurations for type handlers on this configuration
46       *
47       * @param typeHandlers the type handler configurations for this type
48       *   handler service
49       */
50      void setTypeHandler(TypeHandlerConfiguration[] typeHandlers);
51  
52      /**
53       * This interface defines the configuration for a single configuration
54       * type handler.
55       */
56      public static interface TypeHandlerConfiguration extends Configuration {
57  
58          /**
59           * Retrieves the Class type handled by this
60           *   type handler
61           * @return the type handled by this type handler
62           */
63          Class   getType();
64          /**
65           * Sets the type handled by this type handler
66           * @param type the type handled by this type handler
67           */
68          void setType(Class   type);
69  
70          /**
71           * Gets the class of the handler.  This Class must implement either
72           * ComplexConfigurationTypeHandler or ConfigurationTypeHandler.
73           * @return the clas of the handler
74           */
75          Class   getTypeHandlerClass();
76          /**
77           * Sets the type of the handler.  This Class must implement either
78           * ComplexConfigurationTypeHandler or ConfigurationTypeHandler.
79           * @param typeHandler the type handler class to handle these types
80           */
81          void setTypeHandlerClass(Class   typeHandler);
82      }
83  }
84
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags