<change id="DebuggerServiceRegistrations">

        <api name="DebuggerCoreAPI"/>

        <summary>Allow multiple debugger service registrations and position order</summary>

        <version major="1" minor="28"/>

        <date day="8" month="9" year="2010"/>

        <author login="mentlicher"/>

        <compatibility binary="compatible" source="compatible" addition="yes"/>

        <description>

             <p>

             Allow to specify the order of the debugger service registry.

             For the need of being able to define multiple different

             registrations for a single instance, @DebuggerServiceRegistrations

             and ActionsProvider.Registrations annotations are introduced.

             </p>

        </description>

        <class package="org.netbeans.spi.debugger" name="DebuggerServiceRegistration" />

        <class package="org.netbeans.spi.debugger" name="DebuggerServiceRegistrations" />

        <class package="org.netbeans.spi.debugger" name="ActionsProvider" />

        <issue number="190080"/>

    </change>

import java.util.ArrayList;

import java.util.Collection;

import java.util.Collections;

import java.util.Iterator;

import javax.lang.model.element.VariableElement;

import javax.lang.model.type.MirroredTypeException;

import javax.lang.model.type.MirroredTypesException;

import org.netbeans.spi.debugger.ContextProvider;

import org.netbeans.spi.debugger.DebuggerServiceRegistrations;

import org.openide.filesystems.annotations.LayerBuilder;

        for (Element e : env.getElementsAnnotatedWith(ActionsProvider.Registrations.class)) {

            ActionsProvider.Registrations regs = e.getAnnotation(ActionsProvider.Registrations.class);

            for (ActionsProvider.Registration reg : regs.value()) {

                final String path = reg.path();

                final String[] actions = reg.actions();

                final String[] mimeTypes = reg.activateForMIMETypes();

                handleProviderRegistrationInner(e, ActionsProvider.class, path, actions, mimeTypes);

            }

            cnt++;

        }

    private List<? extends TypeMirror> getTypeMirrors(DebuggerServiceRegistration reg, AnnotationMirror am) {

        /* TODO uncomment this after http://bugs.sun.com/view_bug.do?bug_id=6519115 is fixed.

        List<? extends TypeMirror> typeMirrors = null;

        try {

            reg.types();

            throw new IllegalStateException("No type mirros obtained from element "+e);

        } catch (MirroredTypeException mte) {

            typeMirrors = Collections.singletonList(mte.getTypeMirror());

            System.err.println("Have one "+typeMirrors.get(0)+" type mirror for element "+e);

        } catch (MirroredTypesException mte) {

            typeMirrors = mte.getTypeMirrors();

            System.err.println("Have "+typeMirrors.size()+" type mirrors for element "+e);

            System.err.println("    mirrors = "+typeMirrors);

        }

         */

        // TODO: Delete the rest of this method after http://bugs.sun.com/view_bug.do?bug_id=6519115 is fixed.

        List<TypeMirror> typeMirrors = null;

        Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues =

                am.getElementValues();

        //System.err.println("am:\n elementValues = "+elementValues);

        String classNames = null;

        for (ExecutableElement ee : elementValues.keySet()) {

            if (ee.getSimpleName().contentEquals("types")) { // NOI18N

                classNames = elementValues.get(ee).getValue().toString();

            }

        }

        if (classNames == null) {

            throw new IllegalArgumentException("Annotation "+am+" does not provide types");

        }

        //System.err.println("classNames before translation = "+classNames);

        typeMirrors = new ArrayList<TypeMirror>();

        int i1 = 0;

        int i2;

        while ((i2 = classNames.indexOf(',', i1)) > 0 || i1 < classNames.length()) {

            if (i2 < 0) i2 = classNames.length();

            String className = classNames.substring(i1, i2).trim();

            if (className.endsWith(".class")) {

                className = className.substring(0, className.length() - ".class".length());

            }

            TypeElement type = processingEnv.getElementUtils().getTypeElement(className);

            typeMirrors.add(type.asType());

            i1 = i2 + 1;

        }

        //System.err.println("=> type mirrors = "+typeMirrors);

        return typeMirrors;

    }

    private void handleServiceRegistration(Element e, DebuggerServiceRegistration reg, AnnotationMirror am) throws LayerGenerationException {

        // Class[] classes = reg.types(); - Cant NOT do that, classes are not created at compile time.

        // e.getAnnotationMirrors() - use this not to generate MirroredTypeException

        List<? extends TypeMirror> typeMirrors = getTypeMirrors(reg, am);

        List<? extends TypeMirror> notImplTypeMirrors = implementsInterfaces(e, typeMirrors);

        if (!notImplTypeMirrors.isEmpty()) {

            throw new IllegalArgumentException("Annotated element "+e+" does not implement all interfaces " + notImplTypeMirrors);

        }

        String path = reg.path();

        LayerBuilder lb = layer(e);

        String className = instantiableClassOrMethod(e);

        //System.err.println("icm = "+className);

        StringBuilder classNamesBuilder = new StringBuilder();

        for (TypeMirror tm : typeMirrors) {

            TypeElement te = (TypeElement) processingEnv.getTypeUtils().asElement(tm);

            String cn;

            if (te != null) {

                cn = processingEnv.getElementUtils().getBinaryName(te).toString();

            } else {

                cn = tm.toString();

            }

            if (classNamesBuilder.length() > 0) {

                classNamesBuilder.append(", ");

            }

            classNamesBuilder.append(cn);

        }

        if (path != null && path.length() > 0) {

            path = "Debugger/"+path;

        } else {

            path = "Debugger";

        }

        //System.err.println("path = "+path);

        String basename = className.replace('.', '-');

        LayerBuilder.File f = lb.file(path + "/" + basename + ".instance");

        //LayerBuilder.File f = lb.instanceFile(path, null, Evaluator.class);

        f.stringvalue(ContextAwareServiceHandler.SERVICE_NAME, className).

          //stringvalue("serviceClass", Evaluator.class.getName()).

          stringvalue("instanceOf", classNamesBuilder.toString()).

          methodvalue("instanceCreate", "org.netbeans.spi.debugger.ContextAwareSupport", "createService").

          position(reg.position()).

          write();

    }

                removeImplementingInterfaces(te.asType(), interfaces);

                /*

                 */

    private void removeImplementingInterfaces(TypeMirror tm, Set<String> interfaces) {

        for (Iterator<String> i = interfaces.iterator(); i.hasNext(); ) {

            String type = i.next();

            TypeMirror typeMirror =

                processingEnv.getTypeUtils().getDeclaredType(

                    processingEnv.getElementUtils().getTypeElement(type.replace('$', '.')));

            if (processingEnv.getTypeUtils().isAssignable(tm, typeMirror)) {

                i.remove();

            }

        }

    }

    private List<? extends TypeMirror> implementsInterfaces(Element e, List<? extends TypeMirror> typeMirrors) {

        List<TypeMirror> notImplementedMirrors = Collections.emptyList();

        switch (e.getKind()) {

            case CLASS:

            case INTERFACE: {

                TypeElement te = (TypeElement) e;

                TypeMirror tm = te.asType();

                for (TypeMirror typeMirror : typeMirrors) {

                    if (!processingEnv.getTypeUtils().isAssignable(tm, typeMirror)) {

                        if (notImplementedMirrors == Collections.EMPTY_LIST) {

                            notImplementedMirrors = new ArrayList<TypeMirror>();

                        }

                        notImplementedMirrors.add(typeMirror);

                    }

                }

                /*

                TypeMirror typeMirror = type != null ?

                    processingEnv.getTypeUtils().getDeclaredType(

                        processingEnv.getElementUtils().getTypeElement(type.getName().replace('$', '.'))) :

                    null;

                        processingEnv.getTypeUtils().isAssignable(te.asType(), null);

                 */

                //removeImplementingInterfaces(te.asType(), interfaces);

                /*

                List<? extends TypeMirror> interfs = te.getInterfaces();

                for (TypeMirror tm : interfs) {

                    e = ((DeclaredType) tm).asElement();

                    String clazz = processingEnv.getElementUtils().getBinaryName((TypeElement) e).toString();

                    boolean contains = interfaces.remove(clazz);

                    if (!contains) {

                        implementsInterfaces(e, interfaces);

                    }

                }

                 */

                break;

            }

            case METHOD: {

                TypeMirror retType = ((ExecutableElement) e).getReturnType();

                if (retType.getKind().equals(TypeKind.NONE)) {

                    return typeMirrors;

                } else {

                    TypeElement te = (TypeElement) ((DeclaredType) retType).asElement();

                    TypeMirror tm = te.asType();

                    for (TypeMirror typeMirror : typeMirrors) {

                        if (!processingEnv.getTypeUtils().isAssignable(tm, typeMirror)) {

                            if (notImplementedMirrors == Collections.EMPTY_LIST) {

                                notImplementedMirrors = new ArrayList<TypeMirror>();

                            }

                            notImplementedMirrors.add(typeMirror);

                        }

                    }

                    /*

                    List<? extends TypeMirror> interfs = te.getInterfaces();

                    for (TypeMirror tm : interfs) {

                        e = ((DeclaredType) tm).asElement();

                        String clazz = processingEnv.getElementUtils().getBinaryName((TypeElement) e).toString();

                        interfaces.remove(clazz);

                    }

                     */

                }

                break;

            }

            default:

                throw new IllegalArgumentException("Annotated element is not loadable as an instance: " + e);

        }

        return notImplementedMirrors;

    }

                //System.err.println("instantiableClassOrMethod(): class = "+clazz);

                    boolean hasContextCtor = false;

                        if (parameters.size() == 1) {

                            String type = parameters.get(0).asType().toString();

                            //System.err.println("Param type = "+type);

                            if (ContextProvider.class.getName().equals(type)) {

                                hasContextCtor = true;

                                break;

                            }

                        }

    /**

     * Allows registration of multiple {@link Registration} annotations.

     * @since 1.28

     */

    @Retention(RetentionPolicy.SOURCE)

    @Target({ElementType.TYPE})

    public @interface Registrations {

        Registration[] value();

    }

    /**

     * Position of this service within its path.

     * @since 1.28

     */

    int position() default Integer.MAX_VALUE;

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2009 Sun Microsystems, Inc.

 */

package org.netbeans.spi.debugger;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

 * Allows registration of multiple {@link DebuggerServiceRegistration} annotations.

 * @since 1.28

 *

 * @author Martin Entlicher

 */

@Retention(RetentionPolicy.SOURCE)

@Target({ElementType.TYPE})

public @interface DebuggerServiceRegistrations {

    DebuggerServiceRegistration[] value();

}

import java.util.List;

import javax.lang.model.element.VariableElement;

import org.netbeans.spi.debugger.ContextProvider;

import org.netbeans.spi.debugger.ui.ColumnModelRegistrations;

import org.openide.filesystems.annotations.LayerBuilder;

        for (Element e : env.getElementsAnnotatedWith(ColumnModelRegistrations.class)) {

            ColumnModelRegistrations regs = e.getAnnotation(ColumnModelRegistrations.class);

            for (ColumnModelRegistration reg : regs.value()) {

                final String path = reg.path();

                final int position = reg.position();

                handleProviderRegistration(e, ColumnModel.class, path, position);

            }

            cnt++;

        }

                    boolean hasContextCtor = false;

                        if (parameters.size() == 1) {

                            String type = parameters.get(0).asType().toString();

                            //System.err.println("Param type = "+type);

                            if (ContextProvider.class.getName().equals(type)) {

                                hasContextCtor = true;

                                break;

                            }

                        }

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2009 Sun Microsystems, Inc.

 */

package org.netbeans.spi.debugger.ui;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

 * Allows registration of multiple {@link ColumnModelRegistration} annotations.

 * 

 * @author Martin Entlicher

 * @since 2.25

 */

@Retention(RetentionPolicy.SOURCE)

@Target({ElementType.TYPE, ElementType.METHOD})

public @interface ColumnModelRegistrations {

    ColumnModelRegistration[] value();

}

import org.netbeans.api.debugger.providers.TestMultiModelRegistrations;

    public void testMultiModelRegistrations() throws Exception {

        Lookup.MetaInf l = new Lookup.MetaInf("unittest");

        Object instance;

        {

        List<? extends TreeModel> list = l.lookup("annotated1", TreeModel.class);

        assertEquals("Wrong looked up object", 1, list.size());

        instance = ((TestMultiModelRegistrations) list.get(0)).INSTANCES.iterator().next();

        assertEquals("One provider instance should be created!", 1, TestMultiModelRegistrations.INSTANCES.size());

        List<? extends NodeModel> list2 = l.lookup("annotated1", NodeModel.class);

        assertEquals("Wrong looked up object", 0, list2.size());

        List<? extends TableModel> list3 = l.lookup("annotated1", TableModel.class);

        assertEquals("Wrong looked up object", 0, list3.size());

        }

        {

        List<? extends TreeModel> list = l.lookup("annotated2", TreeModel.class);

        assertEquals("Wrong looked up object", 0, list.size());

        List<? extends NodeModel> list2 = l.lookup("annotated2", NodeModel.class);

        assertEquals("Wrong looked up object", 1, list2.size());

        List<? extends TableModel> list3 = l.lookup("annotated2", TableModel.class);

        assertEquals("Wrong looked up object", 1, list3.size());

        list2.get(0);

        assertEquals("One provider instance should be created!", 1, TestMultiModelRegistrations.INSTANCES.size());

        list3.get(0);

        assertEquals("One provider instance should be created!", 1, TestMultiModelRegistrations.INSTANCES.size());

        }

        {

        List<? extends TreeModel> list = l.lookup("annotated3", TreeModel.class);

        assertEquals("Wrong looked up object", 0, list.size());

        List<? extends NodeModel> list2 = l.lookup("annotated3", NodeModel.class);

        assertEquals("Wrong looked up object", 1, list2.size());

        List<? extends TableModel> list3 = l.lookup("annotated3", TableModel.class);

        assertEquals("Wrong looked up object", 1, list3.size());

        list2.get(0);

        assertEquals("One provider instance should be created!", 1, TestMultiModelRegistrations.INSTANCES.size());

        assertEquals("Wrong instance", instance, list3.get(0));

        assertEquals("One provider instance should be created!", 1, TestMultiModelRegistrations.INSTANCES.size());

        }

    }

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2009 Sun Microsystems, Inc.

 */

package org.netbeans.api.debugger.providers;

import java.util.HashSet;

import java.util.Set;

import org.netbeans.spi.debugger.DebuggerServiceRegistration;

import org.netbeans.spi.debugger.DebuggerServiceRegistrations;

import org.netbeans.spi.viewmodel.ModelListener;

import org.netbeans.spi.viewmodel.NodeModel;

import org.netbeans.spi.viewmodel.TableModel;

import org.netbeans.spi.viewmodel.TreeModel;

import org.netbeans.spi.viewmodel.UnknownTypeException;

/**

 *

 * @author Martin Entlicher

 */

@DebuggerServiceRegistrations({

    @DebuggerServiceRegistration(path="unittest/annotated1", types=TreeModel.class),

    @DebuggerServiceRegistration(path="unittest/annotated2", types={NodeModel.class, TableModel.class}),

    @DebuggerServiceRegistration(path="unittest/annotated3", types={NodeModel.class, TableModel.class})

})

public class TestMultiModelRegistrations implements TreeModel, NodeModel, TableModel {

    public static Set<TestMultiModelRegistrations> INSTANCES = new HashSet<TestMultiModelRegistrations>();

    public TestMultiModelRegistrations() {

        INSTANCES.add(this);

    }

    public Object getRoot() {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public Object[] getChildren(Object parent, int from, int to) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public boolean isLeaf(Object node) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public int getChildrenCount(Object node) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public void addModelListener(ModelListener l) {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public void removeModelListener(ModelListener l) {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public String getDisplayName(Object node) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public String getIconBase(Object node) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public String getShortDescription(Object node) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public Object getValueAt(Object node, String columnID) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public boolean isReadOnly(Object node, String columnID) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

    public void setValueAt(Object node, String columnID, Object value) throws UnknownTypeException {

        throw new UnsupportedOperationException("Not supported yet.");

    }

}