ide/editor.codetemplates/src/org/netbeans/lib/editor/codetemplates/CodeTemplateApiPackageAccessor.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.lib.editor.codetemplates;

import java.util.List;
import org.netbeans.lib.editor.codetemplates.api.CodeTemplate;
import org.netbeans.lib.editor.codetemplates.api.CodeTemplateManager;


/**
 * Accessor for the package-private functionality in org.netbeans.api.editor.fold.
 *
 * @author Miloslav Metelka
 * @version 1.00
 */

public abstract class CodeTemplateApiPackageAccessor {

    private static CodeTemplateApiPackageAccessor INSTANCE;

    public static CodeTemplateApiPackageAccessor get() {
        if (INSTANCE == null) {
            try {
                Class<?> clazz = Class.forName(CodeTemplateManager.class.getName());
            } catch (ClassNotFoundException e) {
                // ignore
            }
        }
        
        assert INSTANCE != null : "There is no API package accessor available!"; //NOI18N
        return INSTANCE;
    }

    /**
     * Register the accessor. The method can only be called once
     * - othewise it throws IllegalStateException.
     * 
     * @param accessor instance.
     */
    public static void register(CodeTemplateApiPackageAccessor accessor) {
        if (INSTANCE != null) {
            throw new IllegalStateException("Already registered"); // NOI18N
        }
        INSTANCE = accessor;
    }
    
    public abstract CodeTemplateManager createCodeTemplateManager(
    CodeTemplateManagerOperation operation);

    public abstract CodeTemplateManagerOperation getOperation(
    CodeTemplateManager manager);

    public abstract CodeTemplateManagerOperation getOperation(
    CodeTemplate codeTemplate);

    public abstract CodeTemplate createCodeTemplate(
        CodeTemplateManagerOperation managerOperation,
        String abbreviation, 
        String description, 
        String parametrizedText,
        List<String> contexts,
        String mimePath);

    public abstract String getSingleLineText(CodeTemplate codeTemplate);
    public abstract String getCodeTemplateMimePath(CodeTemplate codeTemplate);
}