UIClientPropertyKeyTest.java

/*
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

import java.awt.EventQueue;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;

import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.SwingUtilities;
import javax.swing.UIClientPropertyKey;
import javax.swing.UIManager;
import javax.swing.UnsupportedLookAndFeelException;

import static javax.swing.UIManager.getInstalledLookAndFeels;

/**
 * @test
 * @bug 8141544
 */
public final class UIClientPropertyKeyTest {

    private static Object key = new UIClientPropertyKey() {
    };

    public static void main(final String[] args) throws Exception {
        EventQueue.invokeAndWait(UIClientPropertyKeyTest::testSetUI);
        EventQueue.invokeAndWait(UIClientPropertyKeyTest::testSerialization);
    }

    /**
     * UIClientPropertyKey should be removed after deserialization.
     */
    private static void testSerialization() {
        JComponent comp = new JButton();
        comp.putClientProperty("key1", "value1");
        comp.putClientProperty(key, "value2");

        comp = serializeDeserialize(comp);

        validate(comp);
    }

    /**
     * UIClientPropertyKey should be removed on updateUI().
     */
    private static void testSetUI() {
        JComponent comp = new JButton();
        comp.putClientProperty("key1", "value1");
        for (final UIManager.LookAndFeelInfo laf : getInstalledLookAndFeels()) {
            comp.putClientProperty(key, "value2");
            setLookAndFeel(laf);
            SwingUtilities.updateComponentTreeUI(comp);
            validate(comp);
        }
    }

    private static void validate(JComponent comp) {
        Object value = comp.getClientProperty("key1");
        if (!value.equals("value1")) {
            throw new RuntimeException("Incorrect value: " + value);
        }
        value = comp.getClientProperty(key);
        if (value != null) {
            throw new RuntimeException("Incorrect value: " + value);
        }
    }

    private static void setLookAndFeel(final UIManager.LookAndFeelInfo laf) {
        try {
            UIManager.setLookAndFeel(laf.getClassName());
            System.out.println("LookAndFeel: " + laf.getClassName());
        } catch (final UnsupportedLookAndFeelException ignored){
            System.out.println("Unsupported LookAndFeel: " + laf.getClassName());
        } catch (ClassNotFoundException | InstantiationException |
                IllegalAccessException e) {
            throw new RuntimeException(e);
        }
    }

    private static JComponent serializeDeserialize(JComponent comp) {
        try {
            ByteArrayOutputStream byteOut = new ByteArrayOutputStream();
            ObjectOutputStream out = new ObjectOutputStream(byteOut);
            out.writeObject(comp);
            out.close();
            return (JComponent) new ObjectInputStream(new ByteArrayInputStream(
                    byteOut.toByteArray())).readObject();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}