Java Language
предпочтения

algorithm Android HTML javafx JavaScript MySQL Regular Expressions spring spring-boot SQL
Поиск…


Добавление прослушивателей событий

Есть два типа событий , испускаемых Preferences объекта: PreferenceChangeEvent и NodeChangeEvent .

PreferenceChangeEvent

PreferenceChangeEvent получает излучаемый объект Properties каждый раз, когда изменяется одна из пар ключ-значение узла. PreferenceChangeEvent s можно прослушать с помощью PreferenceChangeListener :

Java SE 8 
preferences.addPreferenceChangeListener(evt -> {
    String newValue = evt.getNewValue();
    String changedPreferenceKey = evt.getKey();
    Preferences changedNode = evt.getNode();
});
Java SE 8 
preferences.addPreferenceChangeListener(new PreferenceChangeListener() {
    @Override
    public void preferenceChange(PreferenceChangeEvent evt) {
        String newValue = evt.getNewValue();
        String changedPreferenceKey = evt.getKey();
        Preferences changedNode = evt.getNode();
    }
});

Этот слушатель не будет слушать измененные пары ключевых значений дочерних узлов.

NodeChangeEvent

Это событие будет запущено, когда дочерний узел узла « Properties будет добавлен или удален. 

preferences.addNodeChangeListener(new NodeChangeListener() {
    @Override
    public void childAdded(NodeChangeEvent evt) {
        Preferences addedChild = evt.getChild();
        Preferences parentOfAddedChild = evt.getParent();
    }

    @Override
    public void childRemoved(NodeChangeEvent evt) {
        Preferences removedChild = evt.getChild();
        Preferences parentOfRemovedChild = evt.getParent();
    }
});

Получение подустановок настроек

Объекты Preferences всегда представляют собой определенный узел в целом дереве Preferences , вроде этого: 

/userRoot
├── com
│   └── mycompany
│       └── myapp
│           ├── darkApplicationMode=true
│           ├── showExitConfirmation=false
│           └── windowMaximized=true
└── org
    └── myorganization
        └── anotherapp
            ├── defaultFont=Helvetica
            ├── defaultSavePath=/home/matt/Documents
            └── exporting
                ├── defaultFormat=pdf
                └── openInBrowserAfterExport=false

Чтобы выбрать узел /com/mycompany/myapp :

  1. По соглашению, основанному на пакете класса: 

    package com.mycompany.myapp;

// ...

// Because this class is in the com.mycompany.myapp package, the node
// /com/mycompany/myapp will be returned.
Preferences myApp = Preferences.userNodeForPackage(getClass());

  2. По относительной траектории: 

    Preferences myApp = Preferences.userRoot().node("com/mycompany/myapp");

    Использование относительного пути (путь, не начинающийся с / ), приведет к тому, что путь будет разрешен относительно родительского узла, на котором он разрешен. Например, следующий пример вернет узел пути /one/two/three/com/mycompany/myapp : 

    Preferences prefix = Preferences.userRoot().node("one/two/three");
Preferences myAppWithPrefix = prefix.node("com/mycompany/myapp");
// prefix          is /one/two/three
// myAppWithPrefix is /one/two/three/com/mycompany/myapp

  3. По абсолютной траектории: 

    Preferences myApp = Preferences.userRoot().node("/com/mycompany/myapp");

    Использование абсолютного пути в корневом узле не будет отличаться от использования относительного пути. Разница в том, что, если вызывается на подузле, путь будет разрешен относительно корневого узла. 

    Preferences prefix = Preferences.userRoot().node("one/two/three");
Preferences myAppWitoutPrefix = prefix.node("/com/mycompany/myapp");
// prefix            is /one/two/three
// myAppWitoutPrefix is /com/mycompany/myapp

Координирование настроек доступа к нескольким экземплярам приложений

Все экземпляры Preferences всегда потокобезопасны в потоках одной виртуальной машины Java (JVM). Поскольку Preferences могут быть разделены между несколькими JVM, существуют специальные методы, связанные с синхронизацией изменений между виртуальными машинами.

Если у вас есть приложение, которое должно запускаться только в одном экземпляре , то никакой внешней синхронизации не требуется.

Если у вас есть приложение, которое выполняется в нескольких экземплярах в одной системе, и поэтому для доступа к JVM в системе требуется согласование Preferences , то метод sync() любого узла Preferences может использоваться для обеспечения того, чтобы изменения в узле Preferences видимые для других JVM в системе: 

// Warning: don't use this if your application is intended
// to only run a single instance on a machine once
// (this is probably the case for most desktop applications)
try {
    preferences.sync();
} catch (BackingStoreException e) {
    // Deal with any errors while saving the preferences to the backing storage
    e.printStackTrace();
}

Экспорт предпочтений

Узлы Preferences можно экспортировать в XML-документ, представляющий этот узел. Полученное дерево XML можно снова импортировать. В результате XML-документ будет помнить, был ли он экспортирован из пользовательских или системных Preferences .

Чтобы экспортировать один узел, но не его дочерние узлы :

Java SE 7 
try (OutputStream os = ...) {
    preferences.exportNode(os);
} catch (IOException ioe) {
    // Exception whilst writing data to the OutputStream
    ioe.printStackTrace();
} catch (BackingStoreException bse) {
    // Exception whilst reading from the backing preferences store
    bse.printStackTrace();
}
Java SE 7 
OutputStream os = null;
try {
    os = ...;
    preferences.exportSubtree(os);
} catch (IOException ioe) {
    // Exception whilst writing data to the OutputStream
    ioe.printStackTrace();
} catch (BackingStoreException bse) {
    // Exception whilst reading from the backing preferences store
    bse.printStackTrace();
} finally {
    if (os != null) {
        try {
            os.close();
        } catch (IOException ignored) {}
    }
}

Чтобы экспортировать один узел с его дочерними узлами :

Java SE 7 
try (OutputStream os = ...) {
    preferences.exportNode(os);
} catch (IOException ioe) {
    // Exception whilst writing data to the OutputStream
    ioe.printStackTrace();
} catch (BackingStoreException bse) {
    // Exception whilst reading from the backing preferences store
    bse.printStackTrace();
}
Java SE 7 
OutputStream os = null;
try {
    os = ...;
    preferences.exportSubtree(os);
} catch (IOException ioe) {
    // Exception whilst writing data to the OutputStream
    ioe.printStackTrace();
} catch (BackingStoreException bse) {
    // Exception whilst reading from the backing preferences store
    bse.printStackTrace();
} finally {
    if (os != null) {
        try {
            os.close();
        } catch (IOException ignored) {}
    }
}

Импорт настроек

Узлы Preferences можно импортировать из XML-документа. Импорт предназначен для использования в сочетании с функциями экспорта Preferences , поскольку он создает соответствующие XML-документы.

Документы XML будут помнить, были ли они экспортированы из пользовательских или системных Preferences . Поэтому они могут быть импортированы в их соответствующие деревья Preferences снова, без необходимости выяснять или знать, откуда они пришли. Статическая функция автоматически узнает, был ли XML-документ экспортирован из пользовательских или системных Preferences и будет автоматически импортировать их в дерево, из которого они были экспортированы.

Java SE 7 
try (InputStream is = ...) {
    // This is a static call on the Preferences class
    Preferences.importPreferences(is);
} catch (IOException ioe) {
    // Exception whilst reading data from the InputStream
    ioe.printStackTrace();
} catch (InvalidPreferencesFormatException ipfe) {
    // Exception whilst parsing the XML document tree
    ipfe.printStackTrace();
}
Java SE 7 
InputStream is = null;
try {
    is = ...;
    // This is a static call on the Preferences class
    Preferences.importPreferences(is);
} catch (IOException ioe) {
    // Exception whilst reading data from the InputStream
    ioe.printStackTrace();
} catch (InvalidPreferencesFormatException ipfe) {
    // Exception whilst parsing the XML document tree
    ipfe.printStackTrace();
} finally {
    if (is != null) {
        try {
            is.close();
        } catch (IOException ignored) {}
    }
}

Удаление прослушивателей событий

Слушатели событий могут быть удалены снова с любого узла « Properties , но для этого нужно сохранить экземпляр слушателя.

Java SE 8 
Preferences preferences = Preferences.userNodeForPackage(getClass());

PreferenceChangeListener listener = evt -> {
    System.out.println(evt.getKey() + " got new value " + evt.getNewValue());
};
preferences.addPreferenceChangeListener(listener);

//
// later...
//

preferences.removePreferenceChangeListener(listener);
Java SE 8 
Preferences preferences = Preferences.userNodeForPackage(getClass());

PreferenceChangeListener listener = new PreferenceChangeListener() {
    @Override
    public void preferenceChange(PreferenceChangeEvent evt) {
        System.out.println(evt.getKey() + " got new value " + evt.getNewValue());
    }
};
preferences.addPreferenceChangeListener(listener);

//
// later...
//

preferences.removePreferenceChangeListener(listener);

То же самое относится к NodeChangeListener .

Получение значений предпочтений

Значение узла Preferences может быть типа String , boolean , byte[] , double , float , int или long . Все вызовы должны предоставлять значение по умолчанию, если указанное значение отсутствует в узле « Preferences . 

Preferences preferences = Preferences.userNodeForPackage(getClass());

String someString = preferences.get("someKey", "this is the default value");
boolean someBoolean = preferences.getBoolean("someKey", true);
byte[] someByteArray = preferences.getByteArray("someKey", new byte[0]);
double someDouble = preferences.getDouble("someKey", 887284.4d);
float someFloat = preferences.getFloat("someKey", 38723.3f);
int someInt = preferences.getInt("someKey", 13232);
long someLong = preferences.getLong("someKey", 2827637868234L);

Значения параметров настройки

Чтобы сохранить значение в узле « Preferences , используется один из методов putXXX() . Значение узла Preferences может быть типа String , boolean , byte[] , double , float , int или long . 

Preferences preferences = Preferences.userNodeForPackage(getClass());

preferences.put("someKey", "some String value");
preferences.putBoolean("someKey", false);
preferences.putByteArray("someKey", new byte[0]);
preferences.putDouble("someKey", 187398123.4454d);
preferences.putFloat("someKey", 298321.445f);
preferences.putInt("someKey", 77637);
preferences.putLong("someKey", 2873984729834L);

Использование настроек

Preferences можно использовать для хранения пользовательских настроек, которые отражают настройки личного приложения пользователя, например, их шрифт редактора, независимо от того, предпочитают ли они, чтобы приложение запускалось в полноэкранном режиме, проверяли ли они флажок «Не показывать это снова» и что как это. 

public class ExitConfirmer {
    private static boolean confirmExit() {
        Preferences preferences = Preferences.userNodeForPackage(ExitConfirmer.class);
        boolean doShowDialog = preferences.getBoolean("showExitConfirmation", true); // true is default value

        if (!doShowDialog) {
            return true;
        }

        //
        // Show a dialog here...
        //
        boolean exitWasConfirmed = ...; // whether the user clicked OK or Cancel
        boolean doNotShowAgain = ...; // get value from "Do not show again" checkbox

        if (exitWasConfirmed && doNotShowAgain) {
            // Exit was confirmed and the user chose that the dialog should not be shown again
            // Save these settings to the Preferences object so the dialog will not show again next time
            preferences.putBoolean("showExitConfirmation", false);
        }

        return exitWasConfirmed;
    }

    public static void exit() {
        if (confirmExit()) {
            System.exit(0);
        }
    }
}


Modified text is an extract of the original Stack Overflow Documentation
Лицензировано согласно CC BY-SA 3.0
Не связан с Stack Overflow