com.leafdigital.prefs.api
Interface Preferences

All Superinterfaces:
Singleton

public interface Preferences
extends Singleton

Singleton to provide preferences.

Preferences are currently stored in an XML file. Owner names and preference names must meet the following restrictions:

The first character must be a letter (not digit). Future characters must be letters, digits, _ or -; no spaces or other special characters.

To ensure uniqueness, if you create a new category of PreferencesOwner, begin the string with a word and an underline; Plugin_com.leafdigital.whatever is how the system plugin ones are generated.


Method Summary
 java.lang.String fromBoolean(boolean value)
           
 java.lang.String fromFont(java.awt.Font value)
           
 java.lang.String fromInt(int value)
           
 PreferencesGroup getGroup(Plugin p)
          Returns a preference group.
 PreferencesGroup getGroup(java.lang.String owner)
          Returns a preference group.
 java.lang.String getPluginOwner(Plugin p)
           
 java.lang.String getPluginOwner(java.lang.String className)
           
 java.lang.String getSafeToken(java.lang.String name)
          Given an arbitrary string, returns a token safe to use in preferences names.
 boolean toBoolean(java.lang.String value)
           
 java.awt.Font toFont(java.lang.String value)
           
 int toInt(java.lang.String value)
           
 

Method Detail

getGroup

PreferencesGroup getGroup(java.lang.String owner)
Returns a preference group.

Parameters:
owner - Owner of preference (if in doubt, use getPluginOwner)
Returns:
Group that can be used to check preferences
Throws:
BugException - If owner name is invalid

getGroup

PreferencesGroup getGroup(Plugin p)
Returns a preference group. Shortcut for calling getPluginOwner and getGroup.

Parameters:
p - Plugin owning preference
Returns:
Group that can be used to check preferences

toInt

int toInt(java.lang.String value)
          throws BugException
Parameters:
value - Retrieved preference
Returns:
Value as int
Throws:
BugException - If conversion fails

fromInt

java.lang.String fromInt(int value)
Parameters:
value - Integer
Returns:
String equivalent

toFont

java.awt.Font toFont(java.lang.String value)
                     throws BugException
Parameters:
value - Retrieved preference
Returns:
Value as font
Throws:
BugException - If conversion fails

fromFont

java.lang.String fromFont(java.awt.Font value)
Parameters:
value - Font to represent as string
Returns:
String equivalent of font

toBoolean

boolean toBoolean(java.lang.String value)
                  throws BugException
Parameters:
value - Retrieved preference
Returns:
Value as boolean
Throws:
BugException - If conversion fails

fromBoolean

java.lang.String fromBoolean(boolean value)
Parameters:
value - Boolean to represent as string
Returns:
String equivalent of boolean

getSafeToken

java.lang.String getSafeToken(java.lang.String name)
Given an arbitrary string, returns a token safe to use in preferences names.

Parameters:
name - String
Returns:
Safed string

getPluginOwner

java.lang.String getPluginOwner(Plugin p)
Parameters:
p - Plugin
Returns:
Owner string representing a particular plugin

getPluginOwner

java.lang.String getPluginOwner(java.lang.String className)
Parameters:
className - Plugin class name
Returns:
owner string representing a particular plugin given full class name


Copyright © 2011 Samuel Marshall. All rights reserved.