org.icepdf.ri.util.PropertiesManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icepdf-viewer Show documentation
Show all versions of icepdf-viewer Show documentation
ICEpdf PDF Viewer Reference Implementation (RI)
/*
* Copyright 2006-2017 ICEsoft Technologies Canada Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an "AS
* IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.icepdf.ri.util;
import org.icepdf.core.pobjects.Document;
import javax.swing.*;
import java.io.*;
import java.net.URL;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* This class provides a very basic Properties Management system for the
* viewer application. Settings such as window location and temporary file
* information is managed by this class.
*
* @since 1.0
*/
public class PropertiesManager {
private static final Logger logger =
Logger.getLogger(PropertiesManager.class.toString());
private static final String DEFAULT_HOME_DIR = ".icesoft/icepdf_viewer";
private static final String LOCK_FILE = "_syslock";
private final static String USER_FILENAME = "pdfviewerri.properties";
private final static String BACKUP_FILENAME = "old_pdfviewerri.properties";
//default file for all not specified properties
private static final String DEFAULT_PROP_FILE = "ICEpdfDefault.properties";
private static final String DEFAULT_PROP_FILE_PATH = "org/icepdf/ri/viewer/res/";
public static final String DEFAULT_MESSAGE_BUNDLE = "org.icepdf.ri.resources.MessageBundle";
private static final String PROPERTY_DEFAULT_FILE_PATH = "application.defaultFilePath";
private static final String PROPERTY_DEFAULT_URL = "application.defaultURL";
// window properties
public static final String PROPERTY_DIVIDER_LOCATION = "application.divider.location";
// default page fit mode
public static final String PROPERTY_DEFAULT_PAGEFIT = "document.pagefitMode";
// default print media size.
public static final String PROPERTY_PRINT_MEDIA_SIZE_WIDTH = "document.print.mediaSize.width";
public static final String PROPERTY_PRINT_MEDIA_SIZE_HEIGHT = "document.print.mediaSize.height";
public static final String PROPERTY_PRINT_MEDIA_SIZE_UNIT = "document.print.mediaSize.unit";
// system properties
public static final String SYSPROPERTY_HIGHLIGHT_COLOR = "org.icepdf.core.views.page.text.highlightColor";
// properties used to hide/show toolbars
public static final String PROPERTY_SHOW_TOOLBAR_UTILITY = "application.toolbar.show.utility";
public static final String PROPERTY_SHOW_TOOLBAR_PAGENAV = "application.toolbar.show.pagenav";
public static final String PROPERTY_SHOW_TOOLBAR_ZOOM = "application.toolbar.show.zoom";
public static final String PROPERTY_SHOW_TOOLBAR_FIT = "application.toolbar.show.fit";
public static final String PROPERTY_SHOW_TOOLBAR_ROTATE = "application.toolbar.show.rotate";
public static final String PROPERTY_SHOW_TOOLBAR_TOOL = "application.toolbar.show.tool";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION = "application.toolbar.show.annotation";
public static final String PROPERTY_SHOW_TOOLBAR_FORMS = "application.toolbar.show.forms";
// properties used to hide/show status bar buttons
public static final String PROPERTY_SHOW_STATUSBAR = "application.statusbar";
// properties used to hide/show status bar status label
public static final String PROPERTY_SHOW_STATUSBAR_STATUSLABEL = "application.statusbar.show.statuslabel";
// properties used to hide/show status bar buttons
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE = "application.statusbar.show.viewmode";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_SINGLE = "application.statusbar.show.viewmode.singlePage";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_SINGLE_CONTINUOUS = "application.statusbar.show.viewmode.singlePageContinuous";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_DOUBLE = "application.statusbar.show.viewmode.doublePage";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_DOUBLE_CONTINUOUS = "application.statusbar.show.viewmode.doublePageContinuous";
// properties used to hide/show the utility buttons (open, print, etc.)
public static final String PROPERTY_SHOW_UTILITY_OPEN = "application.toolbar.show.utility.open";
public static final String PROPERTY_SHOW_UTILITY_SAVE = "application.toolbar.show.utility.save";
public static final String PROPERTY_SHOW_UTILITY_PRINT = "application.toolbar.show.utility.print";
public static final String PROPERTY_SHOW_UTILITY_SEARCH = "application.toolbar.show.utility.search";
public static final String PROPERTY_SHOW_UTILITY_UPANE = "application.toolbar.show.utility.upane";
// properties used to hide/show utility pane tabs
public static final String PROPERTY_HIDE_UTILITYPANE = "application.utilitypane.hide";
public static final String PROPERTY_SHOW_UTILITYPANE_BOOKMARKS = "application.utilitypane.show.bookmarks";
public static final String PROPERTY_SHOW_UTILITYPANE_ATTACHMENTS = "application.utilitypane.show.attachments";
public static final String PROPERTY_SHOW_UTILITYPANE_SEARCH = "application.utilitypane.show.search";
public static final String PROPERTY_SHOW_UTILITYPANE_THUMBNAILS = "application.utilitypane.show.thumbs";
public static final String PROPERTY_SHOW_UTILITYPANE_LAYERS = "application.utilitypane.show.layers";
public static final String PROPERTY_SHOW_UTILITYPANE_ANNOTATION = "application.utilitypane.show.annotation";
public static final String PROPERTY_SHOW_UTILITYPANE_ANNOTATION_FLAGS = "application.utilitypane.show.annotation.flags";
public static final String PROPERTY_SHOW_UTILITYPANE_SIGNATURES = "application.utilitypane.show.signatures";
// default utility pane thumbnail zoom size for non-embedded files
public static final String PROPERTY_UTILITYPANE_THUMBNAILS_ZOOM = "application.utilitypane.thumbnail.zoom";
// properties used for default zoom levels
public static final String PROPERTY_DEFAULT_ZOOM_LEVEL = "application.zoom.factor.default";
public static final String PROPERTY_ZOOM_RANGES = "application.zoom.range.default";
// property to hide/show menu keyboard accelerator shortcuts
public static final String PROPERTY_SHOW_KEYBOARD_SHORTCUTS = "application.menuitem.show.keyboard.shortcuts";
// properties used for overriding ViewerPreferences pulled from the document
public static final String PROPERTY_VIEWPREF_HIDETOOLBAR = "application.viewerpreferences.hidetoolbar";
public static final String PROPERTY_VIEWPREF_HIDEMENUBAR = "application.viewerpreferences.hidemenubar";
public static final String PROPERTY_VIEWPREF_FITWINDOW = "application.viewerpreferences.fitwindow";
public static final String PROPERTY_VIEWPREF_FORM_HIGHLIGHT = "application.viewerpreferences.form.highlight";
// properties used to control visibility of annotation controls on main utility panel.
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_HIGHLIGHT = "application.toolbar.annotation.show.highlight";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_UNDERLINE = "application.toolbar.annotation.show.underline";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_STRIKE_OUT = "application.toolbar.annotation.show.strikeOut";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_LINE = "application.toolbar.annotation.show.line";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_LINK = "application.toolbar.annotation.show.link";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_ARROW = "application.toolbar.annotation.show.arrow";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_RECTANGLE = "application.toolbar.annotation.show.rectangle";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_CIRCLE = "application.toolbar.annotation.show.circle";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_INK = "application.toolbar.annotation.show.ink";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_FREE_TEXT = "application.toolbar.annotation.show.freeText";
public static final String PROPERTY_SHOW_UTILITY_ANNOTATION_TEXT = "application.toolbar.annotation.show.text";
// Individual controls for the annotation toolbar button commands
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_SELECTION = "application.toolbar.show.annotation.selection";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_HIGHLIGHT = "application.toolbar.show.annotation.highlight";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_TEXT = "application.toolbar.show.annotation.text";
// Individual control of the markup annotation context menu
public static final String PROPERTY_SHOW_ANNOTATION_MARKUP_REPLY_TO = "application.annotation.show.markup.replyTo";
public static final String PROPERTY_SHOW_ANNOTATION_MARKUP_SET_STATUS = "application.annotation.show.markup.setStatus";
//the version name, used in about dialog and start-up message
String versionName = Document.getLibraryVersion();
private boolean unrecoverableError;
Properties sysProps;
private ResourceBundle messageBundle;
File userHome;
//the swingri home directory
private File dataDir;
//not to save the bookmarks and properties if lockDir == null, that is
//when we do not own the lock
private File lockDir;
private File propertyFile;
private Date myLastModif = new Date();
private Properties props;
private Properties defaultProps;
private boolean userRejectedCreatingLocalDataDir;
private boolean thisExecutionTriedCreatingLocalDataDir;
public PropertiesManager(Properties sysProps, ResourceBundle messageBundle) {
this(sysProps, new Properties(), messageBundle);
}
/**
* New instance of properties manager with properties overrides defined
* in props.
*
* @param sysProps system properties
* @param props Properties object containing properties that will be applied
* over the default properties have been setup.
* @param messageBundle message bundle for i8n that allows dialogs in this
* class to correct display the associated language
*/
public PropertiesManager(Properties sysProps, Properties props, ResourceBundle messageBundle) {
unrecoverableError = true;
this.sysProps = sysProps;
this.messageBundle = messageBundle;
// load default properties from viewer jar and assigned to defaultProps.
if (!setupDefaultProperties()) {
return;
}
// copy over any properties defined in props.
if (props != null) {
Enumeration keys = props.keys();
String key;
while (keys.hasMoreElements()) {
key = (String) keys.nextElement();
this.props.setProperty(key, props.getProperty(key));
}
}
// create default home directory
setupHomeDir(null);
// load persisted properties saved in users home directory.
loadProperties();
recordMofifTime();
setupLock();
unrecoverableError = false;
}
/**
* New instance of properties manager with properties overrides defined
* in an external file defined by propPath.
*
* @param sysProps system properties
* @param propPath Properties file containing properties that will be applied
* over the default properties have been setup.
* @param messageBundle message bundle for i8n that allows dialogs in this
* class to correct display the associated language
*/
public PropertiesManager(Properties sysProps, String propPath, ResourceBundle messageBundle) {
unrecoverableError = true;
this.sysProps = sysProps;
this.messageBundle = messageBundle;
if (!setupDefaultProperties()) {
return;
}
// Set and load the property file if we have one
if (propPath != null) {
propertyFile = new File(propPath);
loadProperties();
}
setupHomeDir(null);
recordMofifTime();
setupLock();
// Ensure at least the default properties get loaded if we haven't already
if (propPath == null) {
loadProperties();
}
unrecoverableError = false;
}
public Properties getSystemProperties() {
return sysProps;
}
private boolean setupDefaultProperties() {
defaultProps = new Properties();
// create program properties with default
try {
InputStream in = getResourceAsStream(DEFAULT_PROP_FILE_PATH, DEFAULT_PROP_FILE);
try {
defaultProps.load(in);
} finally {
in.close();
}
} catch (IOException ex) {
// check to make sure the storage relate dialogs can be shown
if (getBoolean("application.showLocalStorageDialogs", true)) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.session.readError",
DEFAULT_PROP_FILE);
}
// log the error
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, "Error loading default properties cache", ex);
}
return false;
}
props = defaultProps;
return true;
}
boolean hasUserRejectedCreatingLocalDataDir() {
return userRejectedCreatingLocalDataDir;
}
void setUserRejectedCreatingLocalDataDir() {
userRejectedCreatingLocalDataDir = true;
}
boolean unrecoverableError() {
return unrecoverableError;
}
private boolean ownLock() {
return lockDir != null;
}
private void setupHomeDir(String homeString) {
if (homeString == null) {
homeString = sysProps.getProperty("swingri.home");
}
if (homeString != null) {
dataDir = new File(homeString);
} else {
userHome = new File(sysProps.getProperty("user.home"));
String dataDirStr = props.getProperty("application.datadir", DEFAULT_HOME_DIR);
dataDir = new File(userHome, dataDirStr);
}
if (!dataDir.isDirectory()) {
String path = dataDir.getAbsolutePath();
boolean create;
if (hasUserRejectedCreatingLocalDataDir()) {
create = false;
} else if ((getBoolean("application.showLocalStorageDialogs", true))) {
create = Resources.showConfirmDialog(null,
messageBundle, "manager.properties.title",
"manager.properties.createNewDirectory", path);
if (!create)
setUserRejectedCreatingLocalDataDir();
} else {
// Always create local-storage directory if show user prompt dialog setting is false.
create = true;
}
if (!create) {
dataDir = null;
} else {
dataDir.mkdirs();
if (!dataDir.isDirectory()) {
// check to make sure that dialog should be shown on the error.
if (getBoolean("application.showLocalStorageDialogs", true)) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.failedCreation",
dataDir.getAbsolutePath());
}
dataDir = null;
}
thisExecutionTriedCreatingLocalDataDir = true;
}
}
}
private void setupLock() {
if (dataDir == null) {
lockDir = null;
} else {
File dir = new File(dataDir, LOCK_FILE);
if (!dir.mkdir()) {
// Removed dialog window, always assume we can remove another lock - 12/04/2003 - kfyten
// boolean removeIt = res.displayYesOrNo("session.anotherlock", session_date);
dir.delete();
if (!dir.mkdir()) {
dir = null;
// check to make sure that dialog should be shown on the error.
if (getBoolean("application.showLocalStorageDialogs", true)) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.session.nolock", LOCK_FILE);
}
}
}
lockDir = dir;
}
}
private boolean checkPropertyFileValid(File toCheck) {
return ((toCheck != null) && (toCheck.exists()) && (toCheck.canRead()));
}
public synchronized void loadProperties() {
// Check if we already have a properties file
// This can happen if we had one specified by a command line switch
// Otherwise default to the default directory
if (!checkPropertyFileValid(propertyFile)) {
if (dataDir != null) {
propertyFile = new File(dataDir, USER_FILENAME);
}
}
// load properties from last invocation
if (checkPropertyFileValid(propertyFile)) {
try {
InputStream in = new FileInputStream(propertyFile);
try {
props.load(in);
} finally {
in.close();
}
} catch (IOException ex) {
// check to make sure the storage relate dialogs can be shown
if (getBoolean("application.showLocalStorageDialogs", true)) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.session.readError", propertyFile.getAbsolutePath());
}
// log the error
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, "Error loading properties cache", ex);
}
}
}
}
public synchronized void saveAndEnd() {
if (dataDir != null) {
saveProperties();
lockDir.delete();
}
}
public synchronized void saveProperties() {
if (ownLock()) {
long lastModified = propertyFile.lastModified();
boolean saveIt = true;
if (thisExecutionTriedCreatingLocalDataDir) {
saveIt = true;
} else if (getBoolean("application.showLocalStorageDialogs", true)) {
if (lastModified == 0L) {//file does not exist
saveIt = Resources.showConfirmDialog(null,
messageBundle,
"manager.properties.title",
"manager.properties.deleted", propertyFile.getAbsolutePath());
} else if (myLastModif.before(new Date(lastModified))) {
saveIt = Resources.showConfirmDialog(null,
messageBundle,
"manager.properties.title",
"manager.properties.modified", myLastModif);
}
}
if (!saveIt) {
return;
}
try {
FileOutputStream out = new FileOutputStream(propertyFile);
try {
props.store(out, "-- ICEpdf properties --");
} finally {
out.close();
}
recordMofifTime();
} catch (IOException ex) {
// check to make sure the storage relate dialogs can be shown
if (getBoolean("application.showLocalStorageDialogs", true)) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.saveError", ex);
}
// log the error
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, "Error saving properties cache", ex);
}
}
}
}
private void recordMofifTime() {
Calendar c = new GregorianCalendar();
c.setTime(new Date());
c.set(Calendar.MINUTE, c.get(Calendar.MINUTE) + 1);
c.set(Calendar.SECOND, 0);
myLastModif = new Date((c.getTime().getTime() / 1000) * 1000);
}
public boolean backupProperties() {
boolean result = false;
if (ownLock()) {
File backupFile = new File(dataDir, BACKUP_FILENAME);
try {
FileOutputStream out = new FileOutputStream(backupFile);
try {
props.store(out, "-- ICEbrowser properties backup --");
result = true;
} finally {
out.close();
}
} catch (IOException ex) {
// check to make sure the storage relate dialogs can be shown
if (getBoolean("application.showLocalStorageDialogs", true)) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.saveError", ex);
}
// log the error
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, "Error saving properties cache", ex);
}
}
}
return result;
}
public void set(String propertyName, String value) {
props.put(propertyName, value);
}
public void remove(String propertyName) {
props.remove(propertyName);
}
public String getString(String propertyName, String defaultValue) {
String value = (String) props.get(propertyName);
if (value != null) {
return value.trim();
}
value = (String) defaultProps.get(propertyName);
if (value != null) {
return value.trim();
}
return defaultValue;
}
public String getString(String propertyName) {
String value = getString(propertyName, null);
if (value == null) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.missingProperty", propertyName, value);
}
return value;
}
public int getInt(String propertyName, int defaultValue) {
Integer result = getIntImpl(propertyName);
if (result == null) {
return defaultValue;
}
return result.intValue();
}
public int getInt(String propertyName) {
Integer result = getIntImpl(propertyName);
if (result == null) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.missingProperty", propertyName, result);
return 0;
}
return result.intValue();
}
private Integer getIntImpl(String propertyName) {
String value = (String) props.get(propertyName);
if (value != null) {
Integer result = Parse.parseInteger(value, messageBundle);
if (result != null) {
return result;
}
props.remove(propertyName);
}
value = (String) defaultProps.get(propertyName);
if (value != null) {
Integer result = Parse.parseInteger(value, null);
if (result != null) {
return result;
}
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.brokenProperty ", propertyName, value);
}
return null;
}
public void setInt(String propertyName, int value) {
set(propertyName, Integer.toString(value));
}
/**
* Return a double value for the respective propertyName.
* If there is no propertyName then return the
* defaultValue.
*
* @param propertyName Name of property from the ICEdefault.properties file.
* @param defaultValue default value if the propertyNamecan not be found.
* @return double value of the propertyName.
* @since 6.0
*/
public double getDouble(String propertyName, double defaultValue) {
Double result = getDoubleImpl(propertyName);
if (result == null) {
return defaultValue;
}
return result.doubleValue();
}
/**
* Return a double value for the respective propertyName.
*
* @param propertyName Name of property from the ICEdefault.properties file.
* @return double value of the propertyName
* @since 6.0
*/
public double getDouble(String propertyName) {
Double result = getDoubleImpl(propertyName);
if (result == null) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.missingProperty", propertyName, result);
return 0;
}
return result.doubleValue();
}
/**
* Return a float value for the respective propertyName.
*
* @param propertyName Name of property from the ICEdefault.properties file.
* @return double value of the propertyName
* @since 6.0
*/
public float getFloat(String propertyName) {
Float result = getFloatImpl(propertyName);
if (result == null) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.missingProperty", propertyName, result);
return 0;
}
return result.floatValue();
}
/**
* Return the a double value for the respective propertyName.
* If the property value is null then the propertyName is removed
* from the properties object.
*
* @param propertyName Name of propertie from the ICEdefault.properites file.
* @return double value of the propertyName
* @since 6.0
*/
private Double getDoubleImpl(String propertyName) {
String value = (String) props.get(propertyName);
if (value != null) {
Double result = Parse.parseDouble(value, messageBundle);
if (result != null) {
return result;
}
props.remove(propertyName);
}
value = (String) defaultProps.get(propertyName);
if (value != null) {
Double result = Parse.parseDouble(value, messageBundle);
if (result != null) {
return result;
}
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.brokenProperty ", propertyName, value);
}
return null;
}
/**
* Return the a double value for the respective propertyName.
* If the property value is null then the propertyName is removed
* from the properties object.
*
* @param propertyName Name of propertie from the ICEdefault.properites file.
* @return double value of the propertyName
* @since 6.0
*/
private Float getFloatImpl(String propertyName) {
String value = (String) props.get(propertyName);
if (value != null) {
Float result = Parse.parseFloat(value, messageBundle);
if (result != null) {
return result;
}
props.remove(propertyName);
}
value = (String) defaultProps.get(propertyName);
if (value != null) {
Float result = Parse.parseFloat(value, messageBundle);
if (result != null) {
return result;
}
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.brokenProperty ", propertyName, value);
}
return null;
}
public void setDouble(String propertyName, double value) {
set(propertyName, Double.toString(value));
}
public void setFloat(String propertyName, float value) {
set(propertyName, Float.toString(value));
}
public long getLong(String propertyName, long defaultValue) {
Long result = getLongImpl(propertyName);
if (result == null) {
return defaultValue;
}
return result.longValue();
}
public long getLong(String propertyName) {
Long result = getLongImpl(propertyName);
if (result == null) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.missingProperty", propertyName, result);
return 0;
}
return result.longValue();
}
private Long getLongImpl(String propertyName) {
String value = (String) props.get(propertyName);
if (value != null) {
Long result = Parse.parseLong(value, messageBundle);
if (result != null) {
return result;
}
props.remove(propertyName);
}
value = (String) defaultProps.get(propertyName);
if (value != null) {
Long result = Parse.parseLong(value, null);
if (result != null) {
return result;
}
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.brokenProperty ", propertyName, value);
}
return null;
}
public void setLong(String propertyName, long value) {
set(propertyName, Long.toString(value));
}
public boolean getBoolean(String propertyName, boolean defaultValue) {
Boolean result = getBooleanImpl(propertyName);
if (result == null) {
return defaultValue;
}
return result == Boolean.TRUE;
}
public boolean getBoolean(String propertyName) {
Boolean result = getBooleanImpl(propertyName);
if (result == null) {
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.missingProperty", propertyName, result);
}
return result == Boolean.TRUE;
}
private Boolean getBooleanImpl(String propertyName) {
String value = (String) props.get(propertyName);
if (value != null) {
Boolean result = Parse.parseBoolean(value, messageBundle);
if (result != null) {
return result;
}
props.remove(propertyName);
}
value = (String) defaultProps.get(propertyName);
if (value != null) {
Boolean result = Parse.parseBoolean(value, null);
if (result != null) {
return result;
}
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.brokenProperty ", propertyName, value);
}
return null;
}
public void setBoolean(String propertyName, boolean value) {
set(propertyName, value ? "true" : "false");
}
public String getSystemEncoding() {
return (new OutputStreamWriter(new ByteArrayOutputStream())).getEncoding();
}
public String getLookAndFeel(String propertyName, String defaultValue) {
String value = (String) props.get(propertyName);
if (value != null) {
String result = Parse.parseLookAndFeel(value, messageBundle);
if (result != null) {
return result;
}
props.remove(propertyName);
}
value = (String) defaultProps.get(propertyName);
if (value != null) {
String result = Parse.parseLookAndFeel(value, null);
if (result != null) {
return result;
}
defaultProps.remove(propertyName);
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.lafError", value);
}
return defaultValue;
}
public String getDefaultFilePath() {
return getString(PROPERTY_DEFAULT_FILE_PATH, null);
}
public String getDefaultURL() {
return getString(PROPERTY_DEFAULT_URL, null);
}
public void setDefaultFilePath(String defaultFilePath) {
if (defaultFilePath == null)
remove(PROPERTY_DEFAULT_FILE_PATH);
else
set(PROPERTY_DEFAULT_FILE_PATH, defaultFilePath);
}
public void setDefaultURL(String defaultURL) {
if (defaultURL == null)
remove(PROPERTY_DEFAULT_URL);
else
set(PROPERTY_DEFAULT_URL, defaultURL);
}
public InputStream getResourceAsStream(String prefix, String resourcePath) {
int colon = resourcePath.indexOf(':');
if (colon >= 0) {
if (resourcePath.lastIndexOf(colon - 1, '/') < 0) {
try {
return (new URL(resourcePath)).openStream();
} catch (IOException e) {
// eat the exception
}
return null;
}
}
resourcePath = makeResPath(prefix, resourcePath);
ClassLoader cl = getClass().getClassLoader();
if (cl != null) {
InputStream result = cl.getResourceAsStream(resourcePath);
if (result != null) {
return result;
}
}
return ClassLoader.getSystemResourceAsStream(resourcePath);
}
public static String makeResPath(String prefix, String base_name) {
if (base_name.length() != 0 && base_name.charAt(0) == '/') {
return base_name.substring(1, base_name.length());
} else if (prefix == null) {
return base_name;
} else {
return prefix + base_name;
}
}
public static boolean checkAndStoreBooleanProperty(PropertiesManager properties, String propertyName) {
return checkAndStoreBooleanProperty(properties, propertyName, true);
}
/**
* Method to check the value of a boolean property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param properties to check with
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return true if property is true, otherwise false
*/
public static boolean checkAndStoreBooleanProperty(PropertiesManager properties, String propertyName, boolean defaultVal) {
// If we don't have a valid PropertiesManager just return the default value
if (properties == null) {
return defaultVal;
}
// Get the desired property, defaulting to the defaultVal parameter
boolean returnValue = properties.getBoolean(propertyName, defaultVal);
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
properties.setBoolean(propertyName, returnValue);
return returnValue;
}
public static double checkAndStoreDoubleProperty(PropertiesManager properties, String propertyName) {
return checkAndStoreDoubleProperty(properties, propertyName, 1.0f);
}
/**
* Method to check the value of a double property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param properties to check with
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return double property value
*/
public static double checkAndStoreDoubleProperty(PropertiesManager properties, String propertyName, double defaultVal) {
// If we don't have a valid PropertiesManager just return the default value
if (properties == null) {
return defaultVal;
}
// Get the desired property, defaulting to the defaultVal parameter
double returnValue = properties.getDouble(propertyName, defaultVal);
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
properties.setDouble(propertyName, returnValue);
return returnValue;
}
public static int checkAndStoreIntegerProperty(PropertiesManager properties, String propertyName) {
return checkAndStoreIntegerProperty(properties, propertyName, 1);
}
/**
* Method to check the value of an int property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param properties to check with
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return int value of property
*/
public static int checkAndStoreIntegerProperty(PropertiesManager properties, String propertyName, int defaultVal) {
// If we don't have a valid PropertiesManager just return the default value
if (properties == null) {
return defaultVal;
}
// Get the desired property, defaulting to the defaultVal parameter
int returnValue = properties.getInt(propertyName, defaultVal);
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
properties.setInt(propertyName, returnValue);
return returnValue;
}
/**
* Method to check the value of a comma separate list of floats property
* For example we will convert "0.4f, 0.5f, 0.6f" to a size 3 array with the values as floats
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param properties to check with
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return array of floats from the property
*/
public static float[] checkAndStoreFloatArrayProperty(PropertiesManager properties, String propertyName, float[] defaultVal) {
// If we don't have a valid PropertiesManager just return the default value
if ((properties == null) || (properties.props == null)) {
return defaultVal;
}
// Get the desired property, defaulting to the defaultVal parameter
String propertyString = properties.props.getProperty(propertyName);
float[] toReturn = defaultVal;
try {
// Ensure we have a property string to parse
// Then we'll conver the comma separated property to a list of floats
if ((propertyString != null) &&
(propertyString.trim().length() > 0)) {
String[] split = propertyString.split(",");
toReturn = new float[split.length];
for (int i = 0; i < split.length; i++) {
try {
toReturn[i] = Float.parseFloat(split[i]);
} catch (NumberFormatException failedValue) {
/* ignore as we'll just automatically put a '0' in the invalid space */
}
}
}
// Otherwise convert the defaultVal into a comma separated list
// This is done so it can be stored back into the properties file
else {
StringBuilder commaBuffer = new StringBuilder(defaultVal.length * 2);
for (int i = 0; i < defaultVal.length; i++) {
commaBuffer.append(defaultVal[i]);
// Check whether we need a comma
if ((i + 1) < defaultVal.length) {
commaBuffer.append(",");
}
}
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
properties.set(propertyName, commaBuffer.toString());
}
} catch (Exception failedProperty) {
/* ignore on failure as we'll just return defaultVal */
}
return toReturn;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy