<summary>Add notification category to the NotificationDisplayer API</summary>

        <version major="7" minor="57"/>

        <date day="20" month="3" year="2013"/>

        <author login="jpeska"/>

        <compatibility addition="yes" binary="compatible" semantic="compatible" deprecation="no" deletion="no" modification="no"/>

        <description>

            Clients can specify notification category. There are 3 default categories (Info, Warning, Error) but clients can also create a custom category using layer.xml

        </description>

        <class package="org.openide.awt" name="NotificationDisplayer"/>

        <issue number="227690"/>

    </change>

    <change id="Actions.checkbox.default">

        <api name="awt"/>

INFO_CATEGORY=Info

INFO_CATEGORY_DESCRIPTION=Informational notifications

WARNING_CATEGORY=Warning

WARNING_CATEGORY_DESCRIPTION=Warning notifications

ERROR_CATEGORY=Error

ERROR_CATEGORY_DESCRIPTION=Error notifications

/*

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

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.openide.awt;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.ResourceBundle;

import org.openide.awt.NotificationDisplayer.Category;

import org.openide.util.Lookup;

import org.openide.util.LookupEvent;

import org.openide.util.LookupListener;

import org.openide.util.NbBundle;

import org.openide.util.lookup.Lookups;

/**

 *

 * @author jpeska

 */

class NotificationCategoryFactory {

    static final String ATTR_CATEGORY_NAME = "categoryName"; //NOI18N

    static final String ATTR_BUNDLE_NAME = "localizingBundle"; //NOI18N

    static final String ATTR_DISPLAY_NAME_KEY = "diplayNameKey"; //NOI18N

    static final String ATTR_DESCRIPTION_KEY = "descriptionKey"; //NOI18N

    private static final String CATEGORY_LIST_PATH = "Notification/Category"; //NOI18N

    private static NotificationCategoryFactory theInstance;

    private Lookup.Result<Category> lookupRes;

    private Map<String, Category> name2category;

    private List<Category> categories;

    private NotificationCategoryFactory() {

    }

    static Category create(Map<String, String> attrs) {

        String categoryName = attrs.get(ATTR_CATEGORY_NAME);

        String bundleName = attrs.get(ATTR_BUNDLE_NAME);

        String displayNameKey = attrs.get(ATTR_DISPLAY_NAME_KEY);

        String descriptionKey = attrs.get(ATTR_DESCRIPTION_KEY);

        return create(categoryName, bundleName, displayNameKey, descriptionKey);

    }

    static Category create(String categoryName, String bundleName, String displayNameKey, String descriptionKey) {

        ResourceBundle bundle = NbBundle.getBundle(bundleName);

        String displayName = bundle.getString(displayNameKey);

        String description = bundle.getString(descriptionKey);

        return new Category(categoryName, displayName, description);

    }

    /**

     * @return The one and only instance of this class.

     */

    public static NotificationCategoryFactory getInstance() {

        if (null == theInstance) {

            theInstance = new NotificationCategoryFactory();

        }

        return theInstance;

    }

    Category getCategory(String categoryName) {

        assert null != categoryName;

        synchronized (this) {

            initCategories();

            return name2category.get(categoryName);

        }

    }

    List<Category> getCategories() {

        synchronized (this) {

            initCategories();

            return categories;

        }

    }

    private void initCategories() {

        synchronized (this) {

            if (null == name2category) {

                if (null == lookupRes) {

                    lookupRes = initLookup();

                    lookupRes.addLookupListener(new LookupListener() {

                        @Override

                        public void resultChanged(LookupEvent ev) {

                            synchronized (NotificationCategoryFactory.this) {

                                name2category = null;

                                categories = null;

                            }

                        }

                    });

                }

                int index = 0;

                categories = new ArrayList<Category>(Category.getDefaultCategories());

                categories.addAll(lookupRes.allInstances());

                name2category = new HashMap<String, Category>(categories.size());

                for (Category c : categories) {

                    name2category.put(c.getName(), c);

                    c.setIndex(index++);

                }

            }

        }

    }

    private Lookup.Result<Category> initLookup() {

        Lookup lkp = Lookups.forPath(CATEGORY_LIST_PATH);

        Lookup.Template<Category> template = new Lookup.Template<Category>(Category.class);

        Lookup.Result<Category> res = lkp.lookup(template);

        return res;

    }

}

import java.util.ArrayList;

import java.util.List;

import java.util.Map;

import javax.swing.ImageIcon;

import org.openide.util.ImageUtilities;

import org.openide.util.NbBundle;

     * Create and show new notification.

     * @param title Notification title. Html is not supported, any html tags will

     * be escaped.

     * @param icon Notification icon

     * @param detailsText Detailed description of the notification. If detailsAction

     * is non-null then this text will be presented as a clickable link. Html is

     * not supported, any html tags will be escaped.

     * @param detailsAction Action to invoke when user click details text or null.

     * @param priority Notification priority

     * @param category Notification category.

     * @return New notification.

     * @since 7.57

     */

    public Notification notify(String title, Icon icon,

            String detailsText, ActionListener detailsAction, Priority priority, Category category) {

        return notify(title, icon, detailsText, detailsAction, priority);

    }

    /**

     * Create and show new notification.

     *

     * @param title Notification title. Html is not supported, any html tags will be escaped.

     * @param icon Notification icon

     * @param detailsText Detailed description of the notification. If detailsAction

     * is non-null then this text will be presented as a clickable link. Html is

     * not supported, any html tags will be escaped.

     * @param detailsAction Action to invoke when user click details text or null.

     * @param priority Notification priority

     * @param categoryName Notification category name, refers to a custom category created in e.g. layer.xml.

     * @return New notification.

     * @since 7.57

     */

    public Notification notify(String title, Icon icon,

            String detailsText, ActionListener detailsAction, Priority priority, String categoryName) {

        return notify(title, icon, detailsText, detailsAction, priority, NotificationCategoryFactory.getInstance().getCategory(categoryName));

    }

    /**

     * Create and show new notification with customized content.

     * @param title Notification title. Html is not supported, any html tags will

     * be escaped.

     * @param icon Notification icon

     * @param balloonDetails Component that will show below notification title

     * in a balloon.

     * @param popupDetails Component that will show below notification title

     * in notifications list.

     * @param priority Notification priority.

     * @param category Notification category.

     * @return New notification.

     * @since 7.57

     */

    public Notification notify(String title, Icon icon,

            JComponent balloonDetails, JComponent popupDetails, Priority priority, Category category) {

        return notify(title, icon, balloonDetails, popupDetails, priority);

    }

    /**

     Create and show new notification with customized content.

     * @param title Notification title. Html is not supported, any html tags will

     * be escaped.

     * @param icon Notification icon

     * @param balloonDetails Component that will show below notification title

     * in a balloon.

     * @param popupDetails Component that will show below notification title

     * in notifications list.

     * @param priority Notification priority.

     * @param categoryName Notification category name, refers to a custom category created in e.g. layer.xml.

     * @return New notification.

     * @since 7.57

     */

    public Notification notify(String title, Icon icon,

            JComponent balloonDetails, JComponent popupDetails, Priority priority, String categoryName) {

        return notify(title, icon, balloonDetails, popupDetails, priority, NotificationCategoryFactory.getInstance().getCategory(categoryName));

    }

    static Category createCategory(Map<String, String> attrs) {

        return NotificationCategoryFactory.create(attrs);

    }

    /**

/*

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

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.openide.awt;

import java.beans.PropertyVetoException;

import java.io.File;

import java.io.IOException;

import java.net.URL;

import java.net.URLStreamHandler;

import java.net.URLStreamHandlerFactory;

import java.util.Enumeration;

import java.util.List;

import junit.framework.Assert;

import static junit.framework.Assert.assertEquals;

import static junit.framework.Assert.assertFalse;

import static junit.framework.Assert.assertNotNull;

import static junit.framework.Assert.assertNull;

import static junit.framework.Assert.fail;

import org.netbeans.junit.Manager;

import org.netbeans.junit.NbTestCase;

import org.openide.awt.NotificationDisplayer.Category;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileSystem;

import org.openide.filesystems.FileUtil;

import org.openide.filesystems.MultiFileSystem;

import org.openide.filesystems.Repository;

import org.openide.filesystems.XMLFileSystem;

import org.openide.util.Lookup;

import org.openide.util.lookup.Lookups;

import org.openide.util.lookup.ProxyLookup;

/**

 *

 * @author jpeska

 */

public class NotificationCategoryFactoryTest extends NbTestCase {

    public static final String CATEGORY_NAME_A = "nb-notification-unittestA";

    public static final String CATEGORY_DISPLAY_NAME_A = "unitTestCategoryLabelA";

    public static final String CATEGORY_DESCRIPTION_A = "unitTestCategoryDescriptionA";

    public static final String CATEGORY_NAME_B = "nb-notification-unittestB";

    public static final String CATEGORY_DISPLAY_NAME_B = "unitTestCategoryLabelB";

    public static final String CATEGORY_DESCRIPTION_B = "unitTestCategoryDescriptionB";

    public static final String CATEGORY_NAME_C = "nb-notification-unittestC";

    public static final String CATEGORY_DISPLAY_NAME_C = "unitTestCategoryLabelC";

    public static final String CATEGORY_DESCRIPTION_C = "unitTestCategoryDescriptionC";

    static {

        String[] layers = new String[]{"org/openide/awt/mf-layer.xml"};//NOI18N

        IDEInitializer.setup(layers, new Object[0]);

    }

    public NotificationCategoryFactoryTest(String name) {

        super(name);

    }

    public void testGetCategory() {

        NotificationCategoryFactory factory = NotificationCategoryFactory.getInstance();

        List<? extends Category> categories = factory.getCategories();

        categories.removeAll(Category.getDefaultCategories());

        assertEquals(2, categories.size());

        Category cA = categories.get(0);

        assertEquals(CATEGORY_NAME_A, cA.getName());

        assertEquals(CATEGORY_DISPLAY_NAME_A, cA.getDisplayName());

        assertEquals(CATEGORY_DESCRIPTION_A, cA.getDescription());

        Category cB = categories.get(1);

        assertEquals(CATEGORY_NAME_B, cB.getName());

        assertEquals(CATEGORY_DISPLAY_NAME_B, cB.getDisplayName());

        assertEquals(CATEGORY_DESCRIPTION_B, cB.getDescription());

        assertFalse(cA.equals(cB));

        Category category = factory.getCategory(CATEGORY_NAME_A);

        assertNotNull(category);

        assertEquals(CATEGORY_NAME_A, category.getName());

        category = factory.getCategory(CATEGORY_NAME_B);

        assertNotNull(category);

        category = factory.getCategory("unknown category name");

        assertNull(category);

        try {

            factory.getCategory(null);

            fail("null category name is not acceptable");

        } catch (AssertionError e) {

            //expected

        }

    }

    public void testCreate() {

        Category category = NotificationCategoryFactory.create(CATEGORY_NAME_C,

                "org.openide.awt.TestBundle",

                "LBL_unittest_categoryC",

                "HINT_unittest_categoryC");

        assertNotNull(category);

        assertEquals(CATEGORY_NAME_C, category.getName());

        assertEquals(CATEGORY_DISPLAY_NAME_C, category.getDisplayName());

        assertEquals(CATEGORY_DESCRIPTION_C, category.getDescription());

    }

    public static class IDEInitializer extends ProxyLookup {

        public static IDEInitializer DEFAULT_LOOKUP = null;

        private static FileSystem lfs;

        static {

            IDEInitializer.class.getClassLoader().setDefaultAssertionStatus(true);

            System.setProperty("org.openide.util.Lookup", IDEInitializer.class.getName());

            Assert.assertEquals(IDEInitializer.class, Lookup.getDefault().getClass());

        }

        public IDEInitializer() {

            Assert.assertNull(DEFAULT_LOOKUP);

            DEFAULT_LOOKUP = this;

            URL.setURLStreamHandlerFactory(new MyURLHandlerFactory());

        }

        /**

         * Set the global default lookup with the specified content.

         *

         * @param layers xml-layer URLs to be present in the system filesystem.

         * @param instances object instances to be present in the default lookup.

         */

        public static void setup(

                String[] layers,

                Object[] instances) {

            ClassLoader classLoader = IDEInitializer.class.getClassLoader();

            File workDir = new File(Manager.getWorkDirPath());

            URL[] urls = new URL[layers.length];

            int i, k = urls.length;

            for (i = 0; i < k; i++) {

                urls[i] = classLoader.getResource(layers[i]);

            }

            // 1) create repository

            XMLFileSystem systemFS = new XMLFileSystem();

            lfs = FileUtil.createMemoryFileSystem();

            try {

                systemFS.setXmlUrls(urls);

            } catch (Exception ex) {

                ex.printStackTrace();

            }

            MyFileSystem myFileSystem = new MyFileSystem(

                    new FileSystem[]{lfs, systemFS});

            Repository repository = new Repository(myFileSystem);

            Object[] lookupContent = new Object[instances.length + 1];

            lookupContent[0] = repository;

            System.arraycopy(instances, 0, lookupContent, 1, instances.length);

            DEFAULT_LOOKUP.setLookups(new Lookup[]{

                Lookups.fixed(lookupContent),

                Lookups.metaInfServices(classLoader),

                Lookups.singleton(classLoader),});

            Assert.assertTrue(myFileSystem.isDefault());

        }

        public static void cleanWorkDir() {

            try {

                Enumeration en = lfs.getRoot().getChildren(false);

                while (en.hasMoreElements()) {

                    ((FileObject) en.nextElement()).delete();

                }

            } catch (IOException ex) {

                ex.printStackTrace();

            }

        }

        private static class MyFileSystem extends MultiFileSystem {

            public MyFileSystem(FileSystem[] fileSystems) {

                super(fileSystems);

                try {

                    setSystemName("TestFS");

                } catch (PropertyVetoException ex) {

                    ex.printStackTrace();

                }

            }

        }

        private static class MyURLHandlerFactory implements URLStreamHandlerFactory {

            public URLStreamHandler createURLStreamHandler(String protocol) {

                if (protocol.equals("nbfs")) {

                    return FileUtil.nbfsURLStreamHandler();

                }

                return null;

            }

        }

    }

}

LBL_unittest_categoryA=unitTestCategoryLabelA

HINT_unittest_categoryA=unitTestCategoryDescriptionA

LBL_unittest_categoryB=unitTestCategoryLabelB

HINT_unittest_categoryB=unitTestCategoryDescriptionB

LBL_unittest_categoryC=unitTestCategoryLabelC

HINT_unittest_categoryC=unitTestCategoryDescriptionC

<?xml version="1.0"?>

<!--

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 1997-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]"

Contributor(s):

The Original Software is NetBeans. The Initial Developer of the Original

Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

Microsystems, Inc. All Rights Reserved.

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.

-->

<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.0//EN" "http://www.netbeans.org/dtds/filesystem-1_0.dtd">

<filesystem>

    <folder name="Notification">

        <folder name="Category">

            <file name="unittestA.instance">

                <attr name="instanceCreate" methodvalue="org.openide.awt.NotificationDisplayer.createCategory"/>

                <attr name="localizingBundle" stringvalue="org.openide.awt.TestBundle"/>

                <attr name="categoryName" stringvalue="nb-notification-unittestA"/>

                <attr name="diplayNameKey" stringvalue="LBL_unittest_categoryA"/>

                <attr name="descriptionKey" stringvalue="HINT_unittest_categoryA"/>

            </file>

            <file name="unittestB.instance">

                <attr name="instanceCreate" methodvalue="org.openide.awt.NotificationDisplayer.createCategory"/>

                <attr name="localizingBundle" stringvalue="org.openide.awt.TestBundle"/>

                <attr name="categoryName" stringvalue="nb-notification-unittestB"/>

                <attr name="diplayNameKey" stringvalue="LBL_unittest_categoryB"/>

                <attr name="descriptionKey" stringvalue="HINT_unittest_categoryB"/>

            </file>

            <attr name="unittestA.instance/unittestB.instance" boolvalue="true"/>

        </folder>

    </folder>

</filesystem>