Preferences API 入門

図 1 PrefTest1 の実行結果

図 2 システムプリファレンスの使用

図 3 異なるユーザでのシステムプリファレンスの使用

リスト 2 PrefTet2.java

package jp.ne.airnet.sakuraba.prefs;
 
import java.util.prefs.Preferences;
 
public class PrefsTest2 extends PrefsTest1 {
 
    public PrefsTest2() {
        prefs = Preferences.systemNodeForPackage(this.getClass());  // (1)
    }
 
    public static void main(String[] args) {
        PrefsTest2 test = new PrefsTest2();
        if (args.length > 0) {
            test.save(args[0]);
        } else {
            test.load();
        }
    }
}

図 4 Preferences API を未使用時のレジストリ

図 5 Preferences API を使った後のレジストリ

図 6 PrefsTest3 の実行例

図 7 PrefsTest4 の実行例

リスト 3 PrefsTet3.java

package jp.ne.airnet.sakuraba.prefs;
 
import java.util.prefs.Preferences;
 
public class PrefsTest3 {
    Preferences prefs;
 
    public PrefsTest3(){
        prefs = Preferences.userNodeForPackage(this.getClass());
//        prefs = Preferences.systemNodeForPackage(this.getClass());
 
        System.out.print("Prefs Node is : ");
        // ユーザかシステムかを調べる
        if(prefs.isUserNode()){
            System.out.println("User");
        }else{
            System.out.println("System");
        }

        // プリファレンスの場所を調べる
        System.out.println("Prefs Node Name : " + prefs.absolutePath());
    }
 
    public static void main(String[] args){
        new PrefsTest3();
    }
}

リスト 4 PrefsTet4.java

package jp.ne.airnet.sakuraba.prefs;
 
import java.util.prefs.Preferences;
import java.util.prefs.BackingStoreException;
 
public class PrefsTest4 {
    private Preferences prefs;
 
    public PrefsTest4(){
        prefs = Preferences.userRoot();                  // (1)
    }
 
    public void printNode(){
        System.out.println();
        
        try{
            String[] children = prefs.childrenNames();   // (2)
            printNode(prefs, children, 0);
        }catch(BackingStoreException ex){
            ex.printStackTrace();
        }
    }
        
    public void printNode(Preferences parent, String[] childrenNames, int depth){
        try{
            for(int i = 0 ; i < childrenNames.length ; i++){
                for(int j = 0 ; j < depth*2 ; j++){
                    System.out.print(" ");
                }
                System.out.println(childrenNames[i]);

                Preferences node = parent.node(childrenNames[i]);    // (3)
                printNode(node, node.childrenNames(), depth + 1);
            }
        }catch(BackingStoreException ex){
            ex.printStackTrace();
        }
    }
 
    public static void main(String[] args){
        PrefsTest4 test = new PrefsTest4();
        test.printNode();
    }
}

図 11 「デフォルトの読みこみ」の実行

表 1 ユーティリティメソッド群

getBoolean(String key, boolean default)
putBoolean(String key, boolean value)

getByteArray(String key, byte[] default)
putByteArray(String key, byte[] value)

getInt(String key, int default)
putInt(String key, int value)

getLong(String key, long default)
putLong(String key, long value)

getFloat(String key, float default)
putFloat(String key, float value)

getDouble(String key, double default)
putDouble(String key, double value)

リスト 5 Dice.java

package jp.ne.airnet.sakuraba.prefs.dice;
 
import java.awt.Component;
import java.awt.Point;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Random;
import java.util.prefs.Preferences;
import java.util.prefs.BackingStoreException;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
 
public class Dice implements Runnable {
    protected Preferences systemPrefs;
    protected Preferences userPrefs;
 
    // プリファレンスのキー
    private static final String FILEBASE = "filebase";
    private static final String LOCATION_X = "x";
    private static final String LOCATION_Y = "y";
 
    // プリファレンスのデフォルト値
    private static final String DEFAULT_FILEBASE = "dice";
    private static final int DEFAULT_X = 100;
    private static final int DEFAULT_Y = 100;
 
    private static final int NO_DEF = -1;
    private static final int MAX_NUMBER = 6;
 
    // 画像ファイル名
    private String filebase;
 
    // フレーム位置
    private int locationX;
    private int locationY;
 
    protected JFrame frame;
    private JButton button;
    protected JMenu menu;
 
    // イメージを保持するためのリスト
    private List skins;
 
    private Thread thread;
 
    public Dice() {
        // プリファレンスの読みこみ
        loadPreferences();
         
        // フレームの初期設定
        initFrame();
 
        // メニューの初期設定
        initMenu();
 
        // イメージの取りこみ
        skins = new ArrayList();
        setupImages();
 
        // ボタンの初期設定
        initButton();
 
        frame.getContentPane().add(button);
        frame.pack();
        frame.setVisible(true);
    }
 
    // フレームの初期設定
    private void initFrame() {
        frame = new JFrame("Dice");
        setupLocation();
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        
        // フレームが移動したときの処理
        frame.addComponentListener(new ComponentAdapter() {
            public void componentMoved(ComponentEvent event) {
                Component comp = event.getComponent();
                // フレーム位置の書きこみ
                saveLocationPreferences(comp.getLocation());
            }
        });
    }
 
    // メニューの初期設定
    private void initMenu() {
        JMenuBar menuBar = new JMenuBar();
        menu = new JMenu("File");
        menuBar.add(menu);
 
        JMenuItem item = new JMenuItem("Load Images...");
        item.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent event) {
                stop();
 
                // 画像ファイルの再設定
                updateFilebase();
                setupImages();
                frame.pack();
            }
        });
        menu.add(item);
         
        item = new JMenuItem("Load Default");
        item.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent event) {
                stop();
 
                // システムプロパティの読みこみ
                loadSystemPreferences();
                setupLocation();
                setupImages();
                frame.pack();
 
                // ユーザプロパティの削除
                removeUserPreferences();
            }
        });
        menu.add(item);
 
        item = new JMenuItem("Exit");
        item.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent event) {
                System.exit(1);
            }
        });
        menu.add(item);

        frame.setJMenuBar(menuBar);
    }
 
    // ボタンの初期設定
    private void initButton() {
        button = new JButton((ImageIcon)skins.get(0));
        button.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent event) {
                processMouseEvent();
            }
        });
    }
 
    // イメージの設定
    protected void setupImages() {
        skins.clear();
        for (int i = 1 ; i <= MAX_NUMBER ; i++) {
            ImageIcon icon = new ImageIcon(filebase + i + ".jpg");
            skins.add(icon);
        }
 
        if (button != null) {
            button.setIcon((ImageIcon)skins.get(0));
        }
    }
 
    // フレーム位置の設定
    protected void setupLocation() {
        frame.setLocation(locationX, locationY);
    }
 
    // プリファレンスの読みこみ
    private void loadPreferences() {
        // システムプリファレンス
        systemPrefs = Preferences.systemNodeForPackage(this.getClass()); // (1)
        loadSystemPreferences();
 
        // ユーザプリファレンス
        userPrefs = Preferences.userNodeForPackage(this.getClass());     // (1)
        loadUserPreferences();
    }
 
    // システムプリファレンスの読みこみ
    private void loadSystemPreferences() {
        locationX = systemPrefs.getInt(LOCATION_X, DEFAULT_X);          // (2)
        locationY = systemPrefs.getInt(LOCATION_Y, DEFAULT_Y);          // (2)
 
        filebase = systemPrefs.get(FILEBASE, DEFAULT_FILEBASE);         // (2)
    }
 
    // ユーザプリファレンスの読みこみ
    protected void loadUserPreferences() {
        int tmpX = userPrefs.getInt(LOCATION_X, NO_DEF);                // (3);
        if (tmpX != NO_DEF) {
            locationX = tmpX;
        }
 
        int tmpY = userPrefs.getInt(LOCATION_Y, NO_DEF);                // (3)
        if (tmpY != NO_DEF) {
            locationY = tmpY;
        }
 
        String tmpFileBase = userPrefs.get(FILEBASE, DEFAULT_FILEBASE); // (3)
        if (!filebase.equals(tmpFileBase)) {
            filebase = tmpFileBase;
        }
    }
 
    // ウィンドウ位置の保存
    private void saveLocationPreferences(Point location) {
        userPrefs.putInt(LOCATION_X, location.x);                      // (4)
        userPrefs.putInt(LOCATION_Y, location.y);                      // (4)
    }
 
    // 画像ファイル設定の保存
    private void saveFilebasePreferences() {
        userPrefs.put(FILEBASE, filebase);                             // (5)
    }
        
    // ユーザプリファレンスの削除
    // プリファレンスが存在するかを確かめてから、
    // 削除を行う
    private void removeUserPreferences() {                             // (6)
        if (userPrefs.getInt(LOCATION_X, NO_DEF) != NO_DEF) {          // (6)
            userPrefs.remove(LOCATION_X);                              // (6)
        }                                                              // (6)
 
        if (userPrefs.getInt(LOCATION_Y, NO_DEF) != NO_DEF) {          // (6)
            userPrefs.remove(LOCATION_Y);                              // (6)
        }                                                              // (6)
 
        if (!userPrefs.get(FILEBASE, "").equals("")) {                 // (6)
            userPrefs.remove(FILEBASE);                                // (6)
        }                                                              // (6)
    }
 
    // 画像ファイルの更新
    private void updateFilebase() {
        String tmpFilebase = JOptionPane.showInputDialog(frame,
                         "画像ファイル名を入力してください\n画像ファイルは [ファイル名][1〜"
                         + MAX_NUMBER + "].jpg になります");
        if (tmpFilebase != null) {
            int i = 1;
            for (; i <= MAX_NUMBER ; i++) {
                if (!new File(tmpFilebase + i + ".jpg").exists()) {
                    break;
                }
            }
                 
            if (i == MAX_NUMBER + 1){
                filebase = tmpFilebase;
                saveFilebasePreferences();
            } else {
                JOptionPane.showMessageDialog(frame, tmpFilebase + i + ".jpg がありません",
                                              "Warning", JOptionPane.WARNING_MESSAGE);
                updateFilebase();
            }
        }
    }
 
    // MouseEvent の処理
    // スレッドが動作しているときは停止、
    // スレッドが停止しているときは開始させる
    private void processMouseEvent() {
        if (thread == null) {
            start();
        } else {
            stop();
        }
    }
 
    // スレッドの開始
    private void start() {
        thread = new Thread(this);
        thread.start();
    }
 
    // スレッドの停止
    protected void stop() {
        if (thread != null) {
            thread.interrupt();
            thread = null;
        }
    }
 
    public void run() {
        Thread currentThread = Thread.currentThread();
        Random rand = new Random();
 
        while (thread == currentThread) {
            // 乱数でサイコロの目を選択して、表示を行う
            int value = rand.nextInt(MAX_NUMBER);
            button.setIcon((ImageIcon)skins.get(value));
 
            try {
                Thread.sleep(100L);
            } catch (InterruptedException ex) {
                return;
            }
        }
    }
 
    public static void main(String[] args) {
        new Dice();
    }
}

リスト 6 プリファレンスの存在確認を行わない removeUserPreferences メソッド

    private void removeUserPreferences() {
        userPrefs.remove(LOCATION_X);
        userPrefs.remove(LOCATION_Y);
        userPrefs.remove(FILEBASE);
    }

図12 設定のエクスポート

リスト 7 Dice2.java

package jp.ne.airnet.sakuraba.prefs.dice;
 
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.prefs.Preferences;
import java.util.prefs.BackingStoreException;
import java.util.prefs.InvalidPreferencesFormatException;
import javax.swing.JFileChooser;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
 
public class Dice2 extends Dice {
 
    public Dice2() {
        super();
        addMenu();
    }
 
    // メニューの追加
    //     追加メニュー    設定をファイルから読み込む
    //                     設定をファイルに書き込む
    private void addMenu() {
        JMenuItem item = new JMenuItem("Import Configuration...");
        item.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent event) {
                stop();
                importUserPreferences();
            }
        });
        menu.add(item, 2);
 
        item = new JMenuItem("Export Configuration...");
        item.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent event) {
                stop();
                exportUserPreferences();
            }
        });
        menu.add(item, 3);
    }
 
    // ファイルからプリファレンスを読み込む
    private void importUserPreferences() {
        FileInputStream stream = null;
 
        try {
            JFileChooser chooser = new JFileChooser();
            chooser.setFileFilter(new XMLFileFilter());
            chooser.setCurrentDirectory(new File("."));
 
            if (chooser.showOpenDialog(frame) == JFileChooser.APPROVE_OPTION) {
                stream = new FileInputStream(chooser.getSelectedFile());
                userPrefs.importPreferences(stream);
                 
                loadUserPreferences();
                setupLocation();
                setupImages();
            }
        } catch (FileNotFoundException ex) {
            warnFileImporting();
        } catch (IOException ex) {
            warnFileImporting();
        } catch (InvalidPreferencesFormatException ex) {
            warnFileImporting();
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ex) {
                    ex.printStackTrace();
                }
            }
        }
    }
 
    // ファイルにプリファレンスを書き込む
    private void exportUserPreferences() {
        FileOutputStream stream = null;
 
        try{
            JFileChooser chooser = new JFileChooser();
            chooser.setFileFilter(new XMLFileFilter());
            chooser.setCurrentDirectory(new File("."));
 
            if (chooser.showSaveDialog(frame) == JFileChooser.APPROVE_OPTION) {
                stream = new FileOutputStream(chooser.getSelectedFile());
                userPrefs.exportNode(stream);
            }
        } catch (FileNotFoundException ex){
            warnFileExporting();
        } catch (IOException ex) {
            warnFileExporting();
        } catch (BackingStoreException ex) {
            warnFileExporting();
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ex) {
                    ex.printStackTrace();
                }
            }
        }
    }
 
    private void warnFileImporting() {
        JOptionPane.showMessageDialog(frame, "インポートに失敗しました",
                                      "Warning", JOptionPane.WARNING_MESSAGE);
    }
 
    private void warnFileExporting() {
        JOptionPane.showMessageDialog(frame, "エクスポートに失敗しました",
                                      "Warning", JOptionPane.WARNING_MESSAGE);
    }
 
    public static void main(String[] args) {
        new Dice2();
    }
}

リスト 8 エクスポートしたファイルサンプル

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE preferences SYSTEM 'http://java.sun.com/dtd/preferences.dtd'>

<preferences EXTERNAL_XML_VERSION="1.0">
  <root type="user">
    <map />
    <node name="jp">
      <map />
      <node name="ne">
        <map />
        <node name="airnet">
          <map />
          <node name="sakuraba">
            <map />
            <node name="prefs">
              <map />
              <node name="dice">
                <map>
                  <entry key="x" value="100" />
                  <entry key="y" value="100" />
                  <entry key="filebase" value="number" />
                </map>
              </node>
            </node>
          </node>
        </node>
      </node>
    </node>
  </root>
</preferences>

図 13 設定のインポート

リスト 9 exportUserPreferences メソッド

    private void exportUserPreferences() {
        FileOutputStream stream = null;
 
        try{
            JFileChooser chooser = new JFileChooser();
            chooser.setFileFilter(new XMLFileFilter());
            chooser.setCurrentDirectory(new File("."));
 
            if (chooser.showSaveDialog(frame) == JFileChooser.APPROVE_OPTION) {
                stream = new FileOutputStream(chooser.getSelectedFile());           // (1)
                userPrefs.exportNode(stream);                                       // (2)
            }
        } catch (FileNotFoundException ex){
            warnFileExporting();
        } catch (IOException ex) {
            warnFileExporting();
        } catch (BackingStoreException ex) {
            warnFileExporting();
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ex) {
                    ex.printStackTrace();
                }
            }
        }
    }

リスト 10 importUserPreferences メソッド

    private void importUserPreferences() {
        FileInputStream stream = null;
 
        try {
            JFileChooser chooser = new JFileChooser();
            chooser.setFileFilter(new XMLFileFilter());
            chooser.setCurrentDirectory(new File("."));
 
            if (chooser.showOpenDialog(frame) == JFileChooser.APPROVE_OPTION) {
                stream = new FileInputStream(chooser.getSelectedFile());         // (1)
                userPrefs.importPreferences(stream);                             // (2)
                
                loadUserPreferences();                                           // (3)
                setupLocation();                                                 // (3)
                setupImages();                                                   // (3)
            }
        } catch (FileNotFoundException ex) {
            warnFileImporting();
        } catch (IOException ex) {
            warnFileImporting();
        } catch (InvalidPreferencesFormatException ex) {
            warnFileImporting();
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (IOException ex) {
                    ex.printStackTrace();
                }
            }
        }
    }