bundles/org.simantics.issues/src/org/simantics/issues/preferences/IssuePreferenceUtil.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.issues.preferences;\r
  13 \r
  14 import org.eclipse.core.runtime.preferences.DefaultScope;\r
  15 import org.eclipse.core.runtime.preferences.IEclipsePreferences;\r
  16 import org.eclipse.core.runtime.preferences.IScopeContext;\r
  17 import org.eclipse.core.runtime.preferences.InstanceScope;\r
  18 import org.osgi.service.prefs.BackingStoreException;\r
  19 import org.osgi.service.prefs.Preferences;\r
  20 \r
  21 /**\r
  22  * @author Tuukka Lehtonen\r
  23  */\r
  24 public final class IssuePreferenceUtil {\r
  25 \r
  26     public static final String PLUGIN_ID = "org.simantics.issues";\r
  27 \r
  28     public static IssuePreferences getDefaultPreferences() {\r
  29         return getPreferences(DefaultScope.INSTANCE);\r
  30     }\r
  31 \r
  32     /**\r
  33      * @return\r
  34      */\r
  35     public static IssuePreferences getPreferences() {\r
  36         return getPreferences(InstanceScope.INSTANCE);\r
  37     }\r
  38 \r
  39     /**\r
  40      * @return\r
  41      */\r
  42     public static IssuePreferences getPreferences(IScopeContext context) {\r
  43         Preferences node = context.getNode(PLUGIN_ID);\r
  44         boolean enabled = node.getBoolean(IssuePreferences.P_ISSUES_ENABLED, IssuePreferences.DEFAULT_ISSUES_ENABLED);\r
  45         int maxIssuesToWrite = node.getInt(IssuePreferences.P_MAX_BATCH_ISSUES_TO_WRITE, IssuePreferences.DEFAULT_MAX_BATCH_ISSUES_TO_WRITE);\r
  46         return new IssuePreferences(enabled, maxIssuesToWrite);\r
  47     }\r
  48 \r
  49     /**\r
  50      * @return\r
  51      * @throws BackingStoreException\r
  52      */\r
  53     public static void setPreferences(IssuePreferences commons) {\r
  54         _setPreferences(InstanceScope.INSTANCE, commons);\r
  55     }\r
  56 \r
  57     /**\r
  58      * @return\r
  59      * @throws BackingStoreException\r
  60      */\r
  61     public static void flushPreferences(IssuePreferences commons) throws BackingStoreException {\r
  62         Preferences p = _setPreferences(InstanceScope.INSTANCE, commons);\r
  63         p.flush();\r
  64     }\r
  65 \r
  66     /**\r
  67      * @return\r
  68      * @throws BackingStoreException\r
  69      */\r
  70     public static void setPreferences(IScopeContext context, IssuePreferences prefs) {\r
  71         _setPreferences(context, prefs);\r
  72     }\r
  73 \r
  74     /**\r
  75      * @return\r
  76      * @throws BackingStoreException\r
  77      */\r
  78     private static IEclipsePreferences _setPreferences(IScopeContext context, IssuePreferences prefs) {\r
  79         IEclipsePreferences node = context.getNode(PLUGIN_ID);\r
  80         node.putBoolean(IssuePreferences.P_ISSUES_ENABLED, prefs.enabled);\r
  81         node.putInt(IssuePreferences.P_MAX_BATCH_ISSUES_TO_WRITE, prefs.maxBatchIssuesToWrite);\r
  82         return node;\r
  83     }\r
  84 \r
  85 }\r