KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > lib > editor > codetemplates > spi > CodeTemplateProcessorFactory


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.lib.editor.codetemplates.spi;
21
22 import java.util.Collection JavaDoc;
23
24 /**
25  * Factory constructs code template processor for a given insert request.
26  * <br/>
27  * The factory instances are looked up
28  * by {@link org.netbeans.api.editor.mimelookup.MimeLookup}
29  * so they should be registered in an xml-layer in
30  * <i>Editors/&lt;mime-type&gt;/CodeTemplateProcessorFactories</i> directory.
31  *
32  * @author Miloslav Metelka
33  */
34 public interface CodeTemplateProcessorFactory {
35
36     /**
37      * Create an instance of code template processor for a given insert request.
38      *
39      * @param request non-null code template insert request to be processed
40      * by the given processor instance.
41      * @return non-null instance of the processor. The constructed instance
42      * should be given the insert request so that it can operate on it.
43      */
44     CodeTemplateProcessor createProcessor(CodeTemplateInsertRequest request);
45     
46 }
47
Popular Tags