Examples of org.gradle.gradleplugin.foundation.settings.SettingsNode

Package org.gradle.gradleplugin.foundation.settings

Examples of org.gradle.gradleplugin.foundation.settings.SettingsNode

org.gradle.gradleplugin.foundation.settings.SettingsNode
This provides a mechanism for storing settings. It is a hybrid of a DOM (like xml) and something much simpler like the java preferences. It is first meant to be easy to use. Second, it is supposed to abstract how the settings are actually stored. The point is to allow IDEs and such to store this is whatever manner they choose. Thus, this is vague. Third, it is meant to be relatively easy to implement. While this is a hiearchy, it is not meant to be as complex as XML with arbitrary attributes. Instead, it is only meant to be a key-value pairing. However, the hiearchy allows you to easily have lists and other complex structures without having to worry about name collisions as you would if this were a pure key-value pair. This is meant to be a single tree for the entire application. You shouldn't create these on your own. A node for your use should be given to you by your parent. Only the highest level object should directly create an instance of one of these. It should manage saving and restore these settings. Due to how some 'owners' of the settings work, you should save your settings immediately here (think of this as you would a database). Why? Well, for example: when Idea is the owner in the gradle Idea plugin, it attempts to store its settings very frequently and uses differences in the results to determine if changes have been made to a plugin. As a result, we store things in the setting immediately. This node consists to 3 things: - name: this is the 'key' of key-value pair. It is required. - value: this is the 'value' of key-value pair. It is NOT required. - child nodes: each node can have children nodes. Using these you can create a tree structure storing whatever you like. If you need multiple attributes like XML has, you should create children instead. So if, in xml, you wanted to do: do this instead: node name="myName" value="myvalue" node name="myotherattribute" value="attribute1" node name="somethingelse" value="attribute2" This has several convenience functions for setting and getting values from child nodes. These are meant to be used in more of a java preferences replacement. You should create your own root node of your settings (by call addChildIfNotPresent from a node that is given to you) then you can use these functions and you only need to worry about uniqueness within your own node. @author mhunsicker

     * @param id a unique ID for these settings.
     * @param windowClass Any class. Just used for the preferences mechanism to obtain an instance. Making this an
     * argument gives you more flexibility.
     */
    public static SettingsNode restoreSettings(SettingsNode settingsNode, Window window, String id, Class windowClass) {
        SettingsNode childNode = settingsNode.getChildNode(getPrefix(windowClass, id));
        if (childNode == null) {
            return null;
        }


        int x = childNode.getValueOfChildAsInt(WINDOW_X, window.getLocation().x);
        int y = childNode.getValueOfChildAsInt(WINDOW_Y, window.getLocation().y);
        int width = childNode.getValueOfChildAsInt(WINDOW_WIDTH, window.getSize().width);
        int height = childNode.getValueOfChildAsInt(WINDOW_HEIGHT, window.getSize().height);


        window.setLocation(x, y);
        window.setSize(width, height);


        return childNode;

View Full Code Here

    /**
     * This restores the position of a frame. We not only restore the size, but we'll maximize it if its was maximized
     * when saved.
     */
    public static void restoreSettings(SettingsNode settingsNode, JFrame frame, String id, Class windowClass) {
        SettingsNode childNode = restoreSettings(settingsNode, (Window) frame, id, windowClass);
        if (childNode == null) {
            return;
        }


        int extendedState = childNode.getValueOfChildAsInt(EXTENDED_STATE, frame.getExtendedState());


        if (extendedState != JFrame.ICONIFIED) {
            frame.setExtendedState(extendedState);
        }
    }

View Full Code Here

            frame.setExtendedState(extendedState);
        }
    }


    public static void saveSettings(SettingsNode settingsNode, JSplitPane splitter, String id, Class splitterClass) {
        SettingsNode childNode = settingsNode.addChildIfNotPresent(getPrefix(splitterClass, id));


        childNode.setValueOfChildAsInt(DIVIDER_LOCATION, splitter.getDividerLocation());
    }

View Full Code Here


        childNode.setValueOfChildAsInt(DIVIDER_LOCATION, splitter.getDividerLocation());
    }


    public static void restoreSettings(SettingsNode settingsNode, JSplitPane splitter, String id, Class splitterClass) {
        SettingsNode childNode = settingsNode.getChildNode(getPrefix(splitterClass, id));
        if (childNode == null) {
            return;
        }


        int location = childNode.getValueOfChildAsInt(DIVIDER_LOCATION, splitter.getDividerLocation());
        splitter.setDividerLocation(location);
    }

View Full Code Here

     * @param saveCurrentDirectoryVsSelectedFilesParent this should be true true if you're selecting only directories,
     * false if you're selecting only files. I don't know what if you allow both.
     */
    public static void saveSettings(SettingsNode settingsNode, JFileChooser fileChooser, String id,
                                    Class fileChooserClass, boolean saveCurrentDirectoryVsSelectedFilesParent) {
        SettingsNode childNode = settingsNode.addChildIfNotPresent(getPrefix(fileChooserClass, id));


        String save;
        try {
            if (saveCurrentDirectoryVsSelectedFilesParent) {
                save = fileChooser.getCurrentDirectory().getCanonicalPath();
            } else {
                save = fileChooser.getSelectedFile().getCanonicalPath();
            }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
        if (save != null) {
            childNode.setValueOfChild(DIRECTORY_NAME, save);
        }
    }

View Full Code Here

        }
    }


    public static void restoreSettings(SettingsNode settingsNode, JFileChooser fileChooser, String id,
                                       Class fileChooserClass) {
        SettingsNode childNode = settingsNode.getChildNode(getPrefix(fileChooserClass, id));
        if (childNode == null) {
            return;
        }


        String lastDirectory = childNode.getValueOfChild(DIRECTORY_NAME, null);


        if (lastDirectory != null) {
            fileChooser.setCurrentDirectory(new File(lastDirectory));
        }
    }

View Full Code Here

        assertNull(rootElement.element(SAMPLE_NAME_1));


        //as such, we shouldn't have one at the DOM4JSettingsNode level either.
        assertNull(rootNode.getChildNode(SAMPLE_NAME_1));


        SettingsNode settingsNode = rootNode.addChild(SAMPLE_NAME_1);
        assertNotNull(settingsNode);


        //and now it should be present under both.
        assertNotNull(Dom4JUtility.getChild(rootElement, DOM4JSettingsNode.TAG_NAME, DOM4JSettingsNode.NAME_ATTRIBUTE,
                SAMPLE_NAME_1));

View Full Code Here

        assertNull(rootElement.element(SAMPLE_NAME_1));


        //as such, we shouldn't have one at the DOM4JSettingsNode level either.
        assertNull(rootNode.getChildNode(SAMPLE_NAME_1));


        SettingsNode settingsNode = rootNode.addChildIfNotPresent(SAMPLE_NAME_1);
        assertNotNull(settingsNode);


        //and now it should be present under both.
        assertNotNull(Dom4JUtility.getChild(rootElement, DOM4JSettingsNode.TAG_NAME, DOM4JSettingsNode.NAME_ATTRIBUTE,
                SAMPLE_NAME_1));

View Full Code Here


        List list = Dom4JUtility.getChildren(rootElement, DOM4JSettingsNode.TAG_NAME, DOM4JSettingsNode.NAME_ATTRIBUTE,
                SAMPLE_NAME_1);
        assertEquals(1, list.size());  //there should only be the one element.


        SettingsNode settingsNode = rootNode.addChildIfNotPresent(SAMPLE_NAME_1);
        assertNotNull(settingsNode);


        //it should still be present under both.
        assertNotNull(Dom4JUtility.getChildren(rootElement, DOM4JSettingsNode.TAG_NAME,
                DOM4JSettingsNode.NAME_ATTRIBUTE, SAMPLE_NAME_1));

View Full Code Here

     * This tests that getChildNode works. We'll add some nodes and make sure they are found correctly. We'll also add a
     * duplicate named node. It should never be returned because getChildNode only finds the first one. Lastly, we'll
     * call getChildNode for a node that doesn't exist. It shouldn't be returned.
     */
    public void testGetChildNode() {
        SettingsNode childNode1 = rootNode.addChild(SAMPLE_NAME_1);
        SettingsNode childNode2 = rootNode.addChild(SAMPLE_NAME_2);
        SettingsNode childNode3 = rootNode.addChild(SAMPLE_NAME_3);
        SettingsNode childNode4 = rootNode.addChild(
                SAMPLE_NAME_2);  //this is a duplicate and should never be found via getChildNode.


        assertNotNull(Dom4JUtility.getChild(rootElement, DOM4JSettingsNode.TAG_NAME, DOM4JSettingsNode.NAME_ATTRIBUTE,
                SAMPLE_NAME_1));
        assertNotNull(Dom4JUtility.getChild(rootElement, DOM4JSettingsNode.TAG_NAME, DOM4JSettingsNode.NAME_ATTRIBUTE,
                SAMPLE_NAME_2));
        assertNotNull(Dom4JUtility.getChild(rootElement, DOM4JSettingsNode.TAG_NAME, DOM4JSettingsNode.NAME_ATTRIBUTE,
                SAMPLE_NAME_3));
        assertNotNull(rootNode.getChildNode(SAMPLE_NAME_1));
        assertNotNull(rootNode.getChildNode(SAMPLE_NAME_2));
        assertNotNull(rootNode.getChildNode(SAMPLE_NAME_3));


        SettingsNode foundNode1 = rootNode.getChildNode(SAMPLE_NAME_1);
        assertEquals(foundNode1, childNode1);


        SettingsNode foundNode2 = rootNode.getChildNode(SAMPLE_NAME_2);
        assertEquals(foundNode2, childNode2);


        SettingsNode foundNode3 = rootNode.getChildNode(SAMPLE_NAME_3);
        assertEquals(foundNode3, childNode3);


        //look for the duplicated
        SettingsNode foundNode2B = rootNode.getChildNode(SAMPLE_NAME_2);
        assertEquals(foundNode2B, childNode2);  //should still be childNode2.


        //this one shouldn't be found.
        SettingsNode foundNode4 = rootNode.getChildNode("notpresent");
        assertNull(foundNode4);
    }

View Full Code Here

0 1 2 3 4 5 6 7

TOP

Related Classes of org.gradle.gradleplugin.foundation.settings.SettingsNode

org.gradle.foundation.DOM4JSettingsNodeTest

org.gradle.gradleplugin.foundation.DOM4JSerializer

org.gradle.gradleplugin.foundation.favorites.FavoritesSerializable

org.gradle.gradleplugin.foundation.filters.BasicProjectAndTaskFilter

org.gradle.gradleplugin.userinterface.swing.common.PreferencesAssistant

org.gradle.gradleplugin.userinterface.swing.generic.MainGradlePanel

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.