net.sf.microproperties.Properties Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of microlog-logger-core
Show all versions of microlog-logger-core
Contains the Microlog core classes
The newest version!
/*
* Copyright 2008 The Microproperties project @sourceforge.net
* 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 net.sf.microproperties;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintStream;
import java.util.Enumeration;
import java.util.Hashtable;
/**
*
* The Properties class is used for storing application properties.
* This is greatly influenced by the java.util.Properties class
* found in Java SE. However it is created from scratch to make it as small and
* fast as possible for use in a Java ME environment.
*
* @author Johan Karlsson ([email protected])
*
* @since 0.1
*
*/
public class Properties extends Hashtable {
private static final long serialVersionUID = -5762897418196039268L;
private static final char CR = '\r';
private static final char LF = '\n';
private static final String COMMENT_SIGN = "#";
private static final char EQUAL_CHAR = '=';
private static final int DEFAULT_BUFFER_SIZE = 256;
private final byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
protected Properties defaults;
private final StringBuffer stringBuffer = new StringBuffer(
2 * DEFAULT_BUFFER_SIZE);
/**
* Create a Properties object with no default
* Properties object.
*/
public Properties() {
}
/**
* Create a Properties object with a default
* Properties object.
*
* @param defaults
* the default Properties object.
*/
public Properties(Properties defaults) {
this.defaults = defaults;
}
/**
* Get the property for the
*
* @param key
* the key to get the value for.
* @return the property as a String.
*/
public String getProperty(String key) {
Object propertyObject = get(key);
String property = null;
if (propertyObject instanceof String) {
property = (String) propertyObject;
} else if (propertyObject != null) {
property = propertyObject.toString();
}
if (property == null && defaults != null) {
defaults.getProperty(key);
}
return property;
}
/**
* Get the property for the specified key. If no value is found, the
* defaultValue is returned.
*
* @param key
* the key to search for.
* @param defaultValue
* the default value to be used when no value was found.
*
* @return the property value.
*/
public String getProperty(String key, String defaultValue) {
String property = getProperty(key);
if (property == null) {
property = defaultValue;
}
return property;
}
/**
* Set the property, with the specified key to the
* value.
*
* @param key
* the key to use.
* @param value
* the value to set for the specified
* key.
*/
public Object setProperty(String key, String value) {
return put(key, value);
}
/**
* List the properties to the specified PrintStream.
*
* @param printStream
* the PrintStream to list the properties into.
*/
public void list(PrintStream printStream) {
Enumeration keys = keys();
while (keys.hasMoreElements()) {
String key = (String) keys.nextElement();
printStream.print(key);
printStream.print('=');
String value = getProperty(key);
printStream.println(value);
}
}
/**
* Load the properties using the specified inputStream.
*
* @param inputStream
* the InputStream to read from.
*/
public void load(InputStream inputStream) {
String configString = readPropertyfile(inputStream);
if (configString != null && configString.length() > 3) {
parseConfigString(this, configString);
}
}
/**
* Save the properties to the specified outputStream.
*
* @param outputStream
* the OutputStream to save the properties to.
* @param header
* the header to add. If this is null no header is
* added.
*/
public void save(OutputStream outputStream, String header) {
// TODO implement the save method
}
/**
* Read the property file and put into the a String.
*
* @return a String that contains the content of the file.
*/
private String readPropertyfile(InputStream inputStream) {
String configString = null;
// get a string with the contents of the file; configString
try {
int readBytes = inputStream.read(buffer);
while (readBytes > 0) {
String string = new String(buffer, 0, readBytes, "UTF-8");
stringBuffer.append(string);
readBytes = inputStream.read(buffer);
}
if (stringBuffer.length() > 0) {
configString = stringBuffer.toString();
}
} catch (IOException e) {
System.err.println("Failed to read property file " + e);
} finally {
try {
inputStream.close();
} catch (IOException e) {
System.err.println("Failed to close the property file " + e);
}
}
return configString;
}
/**
* Parse the configuration string that was read from the file.
*
* @param properties
* the properties Hashtable to put the properties
* into.
* @param configString
* the configuration string to parse.
*/
private void parseConfigString(Hashtable properties, String configString) {
int currentIndex = 0;
int length = configString.length();
int linefeedIndex = 0;
while (currentIndex < length) {
linefeedIndex = configString.indexOf(LF, currentIndex);
int endIndex = configString.length();
if (linefeedIndex != -1) {
// Extract one line
endIndex = linefeedIndex;
if (configString.charAt(linefeedIndex - 1) == CR) {
endIndex--;
}
}
String currentLine = configString.substring(currentIndex, endIndex);
// Check if it a comment line => skip it
if (currentLine.startsWith(COMMENT_SIGN)) {
currentIndex = linefeedIndex + 1;
endIndex = currentIndex;
} else {
int equalIndex = currentLine.indexOf(EQUAL_CHAR);
if (equalIndex > 0) {
String key = currentLine.substring(0, equalIndex);
String value = currentLine.substring(equalIndex + 1);
properties.put(key, value);
}
}
if(linefeedIndex != -1){
currentIndex = linefeedIndex + 1;
}else{
currentIndex = configString.length();
}
}
}
}