KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > editor > guards > GuardedSectionsFactory


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
20 package org.netbeans.spi.editor.guards;
21
22 import org.netbeans.api.editor.mimelookup.MimeLookup;
23 import org.netbeans.api.editor.mimelookup.MimePath;
24
25 /**
26  * The factory allows to look up {@link GuardedSectionsProvider} factories for given
27  * mime type. Factories have to be registered under <code>Editors/&lt;mime path&gt;</code>
28  * in the module's layer.
29  *
30  *
31  *
32  * @author Jan Pokorsky
33  */
34 public abstract class GuardedSectionsFactory {
35
36     /**
37      * Use this to find a proper factory instance for the passed mime path.
38      * @param mimePath a mime path
39      * @return the factory instance or <code>null</code>
40      */
41     public static GuardedSectionsFactory find(String JavaDoc mimePath) {
42         MimePath mp = MimePath.get(mimePath);
43         GuardedSectionsFactory factory = null;
44         if (mp != null) {
45             factory = MimeLookup.getLookup(mp).lookup(GuardedSectionsFactory.class);
46         }
47         return factory;
48     }
49     
50     /**
51      * Creates a guarded sections provider.
52      * @param editor an editor support
53      * @return the provider impl
54      */
55     public abstract GuardedSectionsProvider create(GuardedEditorSupport editor);
56     
57 }
58
Popular Tags