ModuleDescriptorProvider


1   // Copyright 2004, 2005 The Apache Software Foundation
2   //
3   // Licensed under the Apache License, Version 2.0 (the "License");
4   // you may not use this file except in compliance with the License.
5   // You may obtain a copy of the License at
6   //
7   //     http://www.apache.org/licenses/LICENSE-2.0
8   //
9   // Unless required by applicable law or agreed to in writing, software
10  // distributed under the License is distributed on an "AS IS" BASIS,
11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  // See the License for the specific language governing permissions and
13  // limitations under the License.
14  
15  package org.apache.hivemind;
16  
17  import java.util.List  ;
18  
19  /**
20   * ModuleDescriptorProviders are used by the {@link org.apache.hivemind.impl.RegistryBuilder} (see
21   * {@link org.apache.hivemind.impl.RegistryBuilder#addModuleDescriptorProvider(ModuleDescriptorProvider)})
22   * to load the {@link org.apache.hivemind.parse.ModuleDescriptor} objects describing the Modules
23   * which will be exposed by the Registry.
24   * <p>
25   * HiveMind's default ModuleDescriptorProvider is the
26   * {@link org.apache.hivemind.impl.XmlModuleDescriptorProvider}, which can load module descriptors
27   * from XML files or resources on the classpath.
28   * 
29   * @author Knut Wannheden
30   * @since 1.1
31   */
32  public interface ModuleDescriptorProvider
33  {
34      /**
35       * Returns a List of {@link org.apache.hivemind.parse.ModuleDescriptor module descriptors}. Any
36       * referenced submodules must also be included in this List.
37       */
38      public List   getModuleDescriptors(ErrorHandler handler);
39  }

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags