|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectnet.sourceforge.java.feednread.backend.configuration.ConfigurationManager
Manages and organizes the entire application configuration. The class itself
only holds the keys to access the configuration values from the internal data
structure in shape of the CONFIG_STORE.
| Field Summary | |
static String |
ADDRESSBAR_VIEW_KEY
The key to access the NewsFeedAddressBar visibility:
|
static String |
ADOPT_REFRESH_INTERVAL_RECURSIVE_KEY
true if refresh interval setting should be adopted
recursively to all Favorites in a Category
or false which means that the setting should only
be adopted to all Favorites situated directly one level
beneath a Category (non recursive)
|
static String |
APPLICATION_BUGTRACKER_HOMEPAGE
The url of the application bug tracker |
static String |
APPLICATION_COPYRIGHT
The application copyright |
static String |
APPLICATION_FEATURE_REQUEST_HOMEPAGE
The url of the application feature request tracker |
static String |
APPLICATION_FORUM_HOMEPAGE
The url of the application forum |
static String |
APPLICATION_HOMEPAGE
The url of the application homepage |
static String |
APPLICATION_MAILING_LIST_HOMEPAGE
The url of the application mailing list |
static String |
APPLICATION_NAME
The application name |
static String |
APPLICATION_TITLE
The full application title |
static String |
APPLICATION_VERSION
The application version [x.y.z(status)] |
static String |
ARCHIVE_OPTIONS_KEY
The key to access the archive options |
static String |
ASK_ON_NEWSFEED_LINK_DETECTION_KEY
true to ask if a Favorite should be created
if a link is detected that potentially points to a NewsFeed.
|
static String |
ASK_ON_REMOVE_CATEGORY_KEY
The flag to decide whether to ask if a Category should be really deleted by the help of an user dialog. |
static String |
ASK_ON_REMOVE_FAVORITE_KEY
The flag to decide whether to ask if a Favorite should be really deleted by the help of an user dialog. |
static String |
ASK_ON_REMOVE_WATCH_FOLDER_KEY
The flag to decide whether to ask if a WatchFolder should be really deleted by the help of an user dialog. |
static String |
ASK_ON_REMOVE_WATCH_KEY
The flag to decide whether to ask if a Watch should be really deleted by the help of an user dialog. |
static String |
AUTHOR_EMAIL
The author email |
static String |
BROWSER_OPTIONS_KEY
Key to access the browser options |
static String |
CACHE_OPTIONS_KEY
The key to access the cache options |
static ConfigurationStore |
CONFIG_STORE
The ConfigurationStore used to administrate the persistent configuration settings. |
static String |
CONFIGURATION_FILENAME
The application configuration filename |
static String |
CONNECTION_OPTIONS_KEY
Key to access the connection options |
static String |
CONNECTION_TIMEOUT_KEY
Specifies the timeout (in milliseconds) to establish the connection to the host. |
static String |
CONTROL_DIVIDER_OPTIONS_KEY
The key to access the control divider options |
static String |
CONTROL_OPTIONS_KEY
The key to access the control options |
static String |
COOLBAR_OPTIONS_KEY
The key to access the coolbar options |
static String |
COOLBAR_ORDER_KEY
The CoolBar order |
static String |
COOLBAR_SIZE_KEY
The CoolBar size |
static String |
COOLBAR_VIEW_KEY
The key to access the CoolBar visibility:
|
static String |
COOLBAR_WRAPPING_KEY
The CoolBar wrapping |
static String |
DEFAULT_ARCHIVE_DIRECTORY_KEY
The default directory to store archived newsfeeds in |
static String |
DEFAULT_ARCHIVED_FILE_SUFFIX
The default file suffix of archived newsfeeds |
static String |
DEFAULT_CACHE_DIRECTORY_KEY
The default directory to cache newsfeeds to |
static String |
DEFAULT_CACHED_FILE_SUFFIX
The default file suffix of cached newsfeeds |
static String |
DEFAULT_CATEGORY_REFRESH_INTERVAL_KEY
The default refresh interval for new Categories
|
static String |
DEFAULT_CONFGIGURATION_ROOT_KEY
The default root configuration key |
static String |
DEFAULT_CONFIGURATION_FILENAME
The application default configuration filename |
static String |
DEFAULT_CONFIGURATION_NAMESPACE
The default configuration xml namespace |
static String |
DEFAULT_ENCLOSURE_DIRECTORY_KEY
The default directory to store rss enclosures to |
static String |
DEFAULT_FAVORITE_REFRESH_INTERVAL_KEY
The default refresh interval for new Favorites
|
static String |
DEFAULT_ICON_CACHE_DIRECTORY
The default directory where newsfeed favorite icons are cached. |
static String |
DEFAULT_ICON_FILE_SUFFIX
The default file suffix of newsfeed favorite icons. |
static String |
DEFAULT_IMAGE_DIRECTORY
The default directory where all application images are stored. |
static String |
DEFAULT_NEWSFEED_ADDRESS_BAR_FILE
The default file to persist the NewsFeedAddressBarContentProvider entries to
|
static String |
DEFAULT_NEWSFEED_FAVORITES_FILE
The default opml file to export the NewsFeedFavoritesTree
structure to
|
static String |
DEFAULT_NEWSFEED_WATCHES_FILE
The default file to export the NewsFeedWatchessTree
structure to
|
static String |
DEFAULT_PODCAST_DIRECTORY_KEY
The default directory to store rss podcast enclosures to |
static String |
DISPLAY_FAVORITE_ICONS_KEY
true if individual Favorite icons are
displayed; false otherwise, i.e. a default icon is used
instead
|
static String |
ENCLOSURE_OPTIONS_KEY
Key to access the enclosure options |
static String |
EXECUTE_ENCLOSURE_AFTER_DOWNLOAD_KEY
true to automatically execute a downloaded enclosure
in its associated application after its download completed.
|
static String |
EXTERNAL_BROWSER_PATH
The path to the external browser executable |
static String |
FAVORITE_OPTIONS_KEY
The key to access the favorite options |
static String |
GENERAL_OPTIONS_KEY
The key to access the general options |
static String |
HTTP_KEEP_ALIVE_KEY
true if http keep alive is enabled; false
if disabled. |
static String |
LANGUAGE_KEY
The language setting as iso2 code which determines the language of the user interface. |
static String |
LANGUAGE_OPTIONS_KEY
The key to access the language options |
static File |
LICENSE_FILE
The license file |
static String |
MAIN_VIEW_DIVIDER_RATIO_KEY
The key to acces the main view divider ratio |
static String |
MARK_ALL_NEWS_READ_ON_CLOSE_TAB
true if all news of a NewsFeed have to be
marked as read when closing a tab; false otherwise
|
static String |
MAX_ARCHIVE_ITEM_SIZE_KEY
The maximum of news items in an archived newsfeed |
static String |
MAX_CONNECTIONS_KEY
The maximum of parallel connections |
static String |
MAX_LIVE_ARCHIVE_SIZE_KEY
The maximum live archive size in newsfeeds |
static String |
MAX_LIVE_CACHE_SIZE_KEY
The maximum live cache size in newsfeeds |
static String |
MAX_PERSISTENT_ARCHIVE_SIZE_KEY
The maximum archive size in kilobytes |
static String |
MAX_PERSISTENT_CACHE_SIZE_KEY
The maximum persistent cache size in kilobytes |
static String |
MAX_TRAY_NOTIFICATION_NEWS_KEY
The maximum number of news titles to display in a tray notification. |
static String |
NEWS_CONTENT_VIEW_KEY
The key to access the NewsContentView visibility:
|
static String |
NEWSFEED_TAB_BAR_VIEW_KEY
The key to access the NewsFeedTabBar visibility:
|
static String |
NEWSFEED_VIEW_DIVIDER_RATIO_KEY
The key to acces the newsfeed view divider ratio |
static String |
NOTIFICATION_BAR_VIEW_KEY
The key to access the NotificationBar view visibility:
|
static String |
NOTIFICATION_DISPLAY_TIME_KEY
The time in milliseconds to display a notification |
static Point |
NOTIFICATION_SHELL_SIZE
The size of the notification Shell |
static String |
ON_OPEN_LINK_BEHAVIOUR
The behaviour to apply when the end-user opens a link |
static String |
OPEN_FAVORITE_ON_CREATION_KEY
true if a Favorite is opened automatically
after its creation.
|
static String |
OUTPUT_VIEW_DIVIDER_RATIO_KEY
The key to acces the output view divider ratio |
static String |
PLAY_PODCAST_AFTER_DOWNLOAD_KEY
true to automatically play a downloaded podcast
in its associated application after its download completed.
|
static String |
PODCAST_OPTIONS_KEY
Key to access the podcast options |
static String |
PROXY_ENABLED_KEY
The key to acces the proxy server enabled flag |
static String |
PROXY_LOGIN_KEY
The key to access the proxy login |
static String |
PROXY_OPTIONS_KEY
The key to access the proxy options |
static String |
PROXY_PASSWORD_KEY
The key to access the proxy password |
static String |
PROXY_PORT_KEY
The key to access the proxy port |
static String |
PROXY_SERVER_KEY
The key to access the proxy server |
static String |
READ_TIMEOUT_KEY
Specifies the timeout (in milliseconds) when reading from input stream when a connection is established to a resource. |
static String |
SEND_TO_TRAY_ON_CLOSE_KEY
true to send to system tray if the
MainApplicationWindow is closed.
|
static String |
SEND_TO_TRAY_ON_MINIMIZE_KEY
true to send to system tray if the
MainApplicationWindow is minimized.
|
static String |
SEND_TO_TRAY_ON_STARTUP_KEY
true to send to tray if the application starts up.
|
static String |
SIDEBAR_VIEW_KEY
The key to access the SideBar visibility:
|
static String |
TRAY_NOTIFICATION_OPTIONS_KEY
Key to access the tray notification options |
static String |
TRAY_OPTIONS_KEY
Key to access the tray options |
static String |
USE_DEFAULT_EXTERNAL_BROWSER
Constant indicating that the default external browser should be used |
static String |
USE_INTERNAL_BROWSER
Constant indicating that the internal browser should be used |
static String |
USE_USERDEFINED_EXTERNAL_BROWSER
Constant indicating that an userdefined external browser should be used |
static String |
WINDOW_HEIGHT_KEY
The window height setting |
static String |
WINDOW_LOCATION_KEY
The window location |
static String |
WINDOW_OPTIONS_KEY
The key to access the window options |
static String |
WINDOW_SIZE_KEY
The window size |
static String |
WINDOW_WIDTH_KEY
The window width setting |
static String |
WINDOW_X_KEY
The window x coordinate setting |
static String |
WINDOW_Y_KEY
The window y coordinate setting |
| Constructor Summary | |
private |
ConfigurationManager()
Private constructor to prevent direct instantiation. |
| Method Summary | |
private static ConfigurationStore |
createConfigurationStore()
Creates the default ConfigurationStore used to
administrate the persistant configuration settings.
|
private static void |
createDirectories()
Create the required application directories if necessary, i.e. if the directories denoted by the following keys do not exist: DEFAULT_CACHE_DIRECTORY_KEY for the cache
DEFAULT_ARCHIVE_DIRECTORY_KEY for the archive
DEFAULT_ENCLOSURE_DIRECTORY_KEY for rss enclosures
DEFAULT_PODCAST_DIRECTORY_KEY for rss podcast enclosures
DEFAULT_ICON_CACHE_DIRECTORY for the icon cache
|
private static void |
verifyDirectorySetting(String key)
Verifies if the directory denoted by the given key
exists. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final ConfigurationStore CONFIG_STORE
The ConfigurationStore used to administrate the persistent configuration settings.
public static final String DEFAULT_NEWSFEED_FAVORITES_FILE
The default opml file to export the NewsFeedFavoritesTree
structure to
public static final String DEFAULT_NEWSFEED_WATCHES_FILE
The default file to export the NewsFeedWatchessTree
structure to
public static final String DEFAULT_NEWSFEED_ADDRESS_BAR_FILE
The default file to persist the
NewsFeedAddressBarContentProvider entries to
public static final String CONFIGURATION_FILENAME
The application configuration filename
public static final String DEFAULT_CONFIGURATION_FILENAME
The application default configuration filename
public static final String DEFAULT_CONFIGURATION_NAMESPACE
The default configuration xml namespace
public static final String DEFAULT_CONFGIGURATION_ROOT_KEY
The default root configuration key
public static final String APPLICATION_NAME
The application name
public static final String APPLICATION_VERSION
The application version [x.y.z(status)]
public static final String APPLICATION_COPYRIGHT
The application copyright
public static final String APPLICATION_TITLE
The full application title
public static final String APPLICATION_HOMEPAGE
The url of the application homepage
public static final String APPLICATION_MAILING_LIST_HOMEPAGE
The url of the application mailing list
public static final String APPLICATION_FORUM_HOMEPAGE
The url of the application forum
public static final String APPLICATION_BUGTRACKER_HOMEPAGE
The url of the application bug tracker
public static final String APPLICATION_FEATURE_REQUEST_HOMEPAGE
The url of the application feature request tracker
public static final String AUTHOR_EMAIL
The author email
public static final String WINDOW_OPTIONS_KEY
The key to access the window options
public static final String WINDOW_LOCATION_KEY
The window location
public static final String WINDOW_SIZE_KEY
The window size
public static final String WINDOW_X_KEY
The window x coordinate setting
public static final String WINDOW_Y_KEY
The window y coordinate setting
public static final String WINDOW_WIDTH_KEY
The window width setting
public static final String WINDOW_HEIGHT_KEY
The window height setting
public static final String COOLBAR_OPTIONS_KEY
The key to access the coolbar options
public static final String COOLBAR_ORDER_KEY
The CoolBar order
public static final String COOLBAR_WRAPPING_KEY
The CoolBar wrapping
public static final String COOLBAR_SIZE_KEY
The CoolBar size
public static final String CONTROL_OPTIONS_KEY
The key to access the control options
public static final String ADDRESSBAR_VIEW_KEY
The key to access the NewsFeedAddressBar visibility:
true if visible; false if invisible.
public static final String COOLBAR_VIEW_KEY
The key to access the CoolBar visibility:
true if visible; false if invisible.
public static final String SIDEBAR_VIEW_KEY
The key to access the SideBar visibility:
true if visible; false if invisible.
public static final String NEWSFEED_TAB_BAR_VIEW_KEY
The key to access the NewsFeedTabBar visibility:
true if visible; false if invisible.
public static final String NEWS_CONTENT_VIEW_KEY
The key to access the NewsContentView visibility:
true if visible; false if invisible.
public static final String NOTIFICATION_BAR_VIEW_KEY
The key to access the NotificationBar view visibility:
true if visible; false if invisible.
public static final String CONTROL_DIVIDER_OPTIONS_KEY
The key to access the control divider options
public static final String NEWSFEED_VIEW_DIVIDER_RATIO_KEY
The key to acces the newsfeed view divider ratio
public static final String OUTPUT_VIEW_DIVIDER_RATIO_KEY
The key to acces the output view divider ratio
public static final String MAIN_VIEW_DIVIDER_RATIO_KEY
The key to acces the main view divider ratio
public static final String GENERAL_OPTIONS_KEY
The key to access the general options
public static final String ASK_ON_REMOVE_FAVORITE_KEY
The flag to decide whether to ask if a Favorite should be really deleted by the help of an user dialog.
public static final String ASK_ON_REMOVE_CATEGORY_KEY
The flag to decide whether to ask if a Category should be really deleted by the help of an user dialog.
public static final String ASK_ON_REMOVE_WATCH_KEY
The flag to decide whether to ask if a Watch should be really deleted by the help of an user dialog.
public static final String ASK_ON_REMOVE_WATCH_FOLDER_KEY
The flag to decide whether to ask if a WatchFolder should be really deleted by the help of an user dialog.
public static final String ASK_ON_NEWSFEED_LINK_DETECTION_KEY
true to ask if a Favorite should be created
if a link is detected that potentially points to a NewsFeed.
public static final String MARK_ALL_NEWS_READ_ON_CLOSE_TAB
true if all news of a NewsFeed have to be
marked as read when closing a tab; false otherwise
public static final String FAVORITE_OPTIONS_KEY
The key to access the favorite options
public static final String DISPLAY_FAVORITE_ICONS_KEY
true if individual Favorite icons are
displayed; false otherwise, i.e. a default icon is used
instead
public static final String OPEN_FAVORITE_ON_CREATION_KEY
true if a Favorite is opened automatically
after its creation.
public static final String ADOPT_REFRESH_INTERVAL_RECURSIVE_KEY
true if refresh interval setting should be adopted
recursively to all Favorites in a Category
or false which means that the setting should only
be adopted to all Favorites situated directly one level
beneath a Category (non recursive)
public static final String DEFAULT_CATEGORY_REFRESH_INTERVAL_KEY
The default refresh interval for new Categories
public static final String DEFAULT_FAVORITE_REFRESH_INTERVAL_KEY
The default refresh interval for new Favorites
public static final String LANGUAGE_OPTIONS_KEY
The key to access the language options
public static final String LANGUAGE_KEY
The language setting as iso2 code which determines the language of the user interface.
public static final String CACHE_OPTIONS_KEY
The key to access the cache options
public static final String DEFAULT_CACHED_FILE_SUFFIX
The default file suffix of cached newsfeeds
public static final String DEFAULT_CACHE_DIRECTORY_KEY
The default directory to cache newsfeeds to
public static final String MAX_LIVE_CACHE_SIZE_KEY
The maximum live cache size in newsfeeds
public static final String MAX_PERSISTENT_CACHE_SIZE_KEY
The maximum persistent cache size in kilobytes
public static final String ARCHIVE_OPTIONS_KEY
The key to access the archive options
public static final String DEFAULT_ARCHIVED_FILE_SUFFIX
The default file suffix of archived newsfeeds
public static final String DEFAULT_ARCHIVE_DIRECTORY_KEY
The default directory to store archived newsfeeds in
public static final String MAX_ARCHIVE_ITEM_SIZE_KEY
The maximum of news items in an archived newsfeed
public static final String MAX_LIVE_ARCHIVE_SIZE_KEY
The maximum live archive size in newsfeeds
public static final String MAX_PERSISTENT_ARCHIVE_SIZE_KEY
The maximum archive size in kilobytes
public static final String CONNECTION_OPTIONS_KEY
Key to access the connection options
public static final String MAX_CONNECTIONS_KEY
The maximum of parallel connections
public static final String CONNECTION_TIMEOUT_KEY
Specifies the timeout (in milliseconds) to establish the connection to the host. For example for http connections it is the timeout when establishing the connection to the http server. For ftp connection it is the timeout when establishing the connection to ftp servers.
public static final String READ_TIMEOUT_KEY
Specifies the timeout (in milliseconds) when reading from input stream when a connection is established to a resource.
public static final String HTTP_KEEP_ALIVE_KEY
true if http keep alive is enabled; false
if disabled.
public static final String PROXY_OPTIONS_KEY
The key to access the proxy options
public static final String PROXY_ENABLED_KEY
The key to acces the proxy server enabled flag
public static final String PROXY_SERVER_KEY
The key to access the proxy server
public static final String PROXY_PORT_KEY
The key to access the proxy port
public static final String PROXY_LOGIN_KEY
The key to access the proxy login
public static final String PROXY_PASSWORD_KEY
The key to access the proxy password
public static final String DEFAULT_IMAGE_DIRECTORY
The default directory where all application images are stored.
public static final String DEFAULT_ICON_CACHE_DIRECTORY
The default directory where newsfeed favorite icons are cached.
public static final String DEFAULT_ICON_FILE_SUFFIX
The default file suffix of newsfeed favorite icons.
public static final String ENCLOSURE_OPTIONS_KEY
Key to access the enclosure options
public static final String DEFAULT_ENCLOSURE_DIRECTORY_KEY
The default directory to store rss enclosures to
public static final String EXECUTE_ENCLOSURE_AFTER_DOWNLOAD_KEY
true to automatically execute a downloaded enclosure
in its associated application after its download completed.
false for quiet mode (no automatic execution).
public static final String PODCAST_OPTIONS_KEY
Key to access the podcast options
public static final String DEFAULT_PODCAST_DIRECTORY_KEY
The default directory to store rss podcast enclosures to
public static final String PLAY_PODCAST_AFTER_DOWNLOAD_KEY
true to automatically play a downloaded podcast
in its associated application after its download completed.
false for quiet mode (no automatic play).
public static final File LICENSE_FILE
The license file
public static final String TRAY_OPTIONS_KEY
Key to access the tray options
public static final String SEND_TO_TRAY_ON_MINIMIZE_KEY
true to send to system tray if the
MainApplicationWindow is minimized.
public static final String SEND_TO_TRAY_ON_CLOSE_KEY
true to send to system tray if the
MainApplicationWindow is closed.
public static final String SEND_TO_TRAY_ON_STARTUP_KEY
true to send to tray if the application starts up.
public static final String TRAY_NOTIFICATION_OPTIONS_KEY
Key to access the tray notification options
public static final String MAX_TRAY_NOTIFICATION_NEWS_KEY
The maximum number of news titles to display in a tray notification.
public static final Point NOTIFICATION_SHELL_SIZE
The size of the notification Shell
public static final String NOTIFICATION_DISPLAY_TIME_KEY
The time in milliseconds to display a notification
public static final String BROWSER_OPTIONS_KEY
Key to access the browser options
public static final String ON_OPEN_LINK_BEHAVIOUR
The behaviour to apply when the end-user opens a link
public static final String EXTERNAL_BROWSER_PATH
The path to the external browser executable
public static final String USE_INTERNAL_BROWSER
Constant indicating that the internal browser should be used
public static final String USE_DEFAULT_EXTERNAL_BROWSER
Constant indicating that the default external browser should be used
public static final String USE_USERDEFINED_EXTERNAL_BROWSER
Constant indicating that an userdefined external browser should be used
EXTERNAL_BROWSER_PATH,
Constant Field Values| Constructor Detail |
private ConfigurationManager()
Private constructor to prevent direct instantiation.
| Method Detail |
private static ConfigurationStore createConfigurationStore()
Creates the default ConfigurationStore used to
administrate the persistant configuration settings.
private static void createDirectories()
Create the required application directories if necessary, i.e. if the directories denoted by the following keys do not exist:
DEFAULT_CACHE_DIRECTORY_KEY for the cacheDEFAULT_ARCHIVE_DIRECTORY_KEY for the archiveDEFAULT_ENCLOSURE_DIRECTORY_KEY for rss enclosuresDEFAULT_PODCAST_DIRECTORY_KEY for rss podcast enclosuresDEFAULT_ICON_CACHE_DIRECTORY for the icon cache
private static void verifyDirectorySetting(String key)
Verifies if the directory denoted by the given key
exists. If not it is created.
key - the key to access the directory setting
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||