MDRManager


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  package org.netbeans.api.mdr;
20  
21  import org.openide.util.Lookup;
22  
23  /** Entry point to the metadata repositories.
24   * Use {@link #getDefault} method to obtain the default instance.
25   * @author Martin Matula
26   * @version 0.1
27   */
28  public abstract class MDRManager {
29      /** Returns the default metadata repository.
30       * @return default metadata repository or <code>null</code> if there is no default metadata repository.
31       */
32      public abstract MDRepository getDefaultRepository();
33  
34      /** Returns metadata repository of a given name.
35       * @param name name of metadata repository
36       * @return metadata repository of a given name or <CODE>null</CODE> if the repository of the given name does not exist.
37       */
38      public abstract MDRepository getRepository(String   name);
39  
40      /** Returns list of names of all available metadata repositories.
41       * @return list of names of all available metadata repositories
42       */
43      public abstract String  [] getRepositoryNames();
44      
45      /** Should be called at the end of the MDR session. Does all the needed clean-up
46       * by calling {@link MDRepository#shutdown} method on each of the repositories.
47       */
48      public void shutdownAll() {
49          String   names[] = getRepositoryNames();
50          for (int i = 0; i < names.length; i++) {
51              getRepository(names[i]).shutdown();
52          }
53      }
54  
55      /** Returns the default instance of MDRManager.
56       * @return Default MDR manager.
57       */    
58      public static MDRManager getDefault() {
59          return (MDRManager) Lookup.getDefault().lookup(MDRManager.class);
60      }
61  }
62  
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags