Package com.peterphi.std.io

Class PropertyFile

java.lang.Object

com.peterphi.std.io.PropertyFile

public class PropertyFile
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	PropertyFile.BlankLine
protected class	PropertyFile.Comment
protected class	PropertyFile.Entry
protected class	PropertyFile.NameValuePair

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	caseSensitive
protected boolean	dirty
protected List<PropertyFile.Entry>	entries
protected File	f
protected boolean	forceNameValueDelimiterWhitespace
protected boolean	readOnly
protected Map<String,PropertyFile.NameValuePair>	vars

Constructor Summary

Constructors

Constructor	Description
PropertyFile()
PropertyFile(File fileName)
PropertyFile(File fileName, boolean caseSensitive)
PropertyFile(InputStream is)
PropertyFile(InputStream is, boolean caseSensitive)
PropertyFile(Reader r)
PropertyFile(Reader r, boolean caseSensitive)
PropertyFile(URL url)
PropertyFile(Map<String,String> map)
PropertyFile(Properties p)
PropertyFile(Properties p, boolean caseSensitive)

Method Summary

Modifier and Type	Method	Description
protected void	_clear()
protected boolean	_contains(String name)
protected String	_get(String name, String defaultValue)
protected String	_get_core(String name, String defaultValue)
protected void	_rm(String name)
protected String	_set(String name, String value)
void	clear()
boolean	containsKey(String name)
static PropertyFile	find()
static PropertyFile	find(ClassLoader classloader, String... fileNames)	Find a property file
static PropertyFile	find(String fileName)
static PropertyFile[]	findAll(ClassLoader loader, String name)	Find all property files by the name name by searching the specified classloader
static PropertyFile[]	findAll(String name)	Find all property files by the name name by searching the classloader that owns PropertyFile
static PropertyFile	fromString(String contents)
static PropertyFile	fromString(String contents, String filename)
String	get(String name)
boolean	get(String name, boolean defaultValue)
int	get(String name, int defaultValue)
long	get(String name, long defaultValue)
String	get(String name, String defaultValue)
byte[]	getBase64(String name)	Get a value which is Base64 encoded
byte[]	getBase64(String name, byte[] defaultValue)	Get a value which is Base64 encoded and has a default value
boolean	getBoolean(String name, boolean defaultValue)
boolean	getCaseSensitive()
Class<?>	getClass(String name, Class<?> defaultValue)
File	getFile()
boolean	getForceNameValueDelimiterWhitespace()
byte[]	getHex(String name)	Get a value which has been encoded in hexidecimal; The encoding may optionally include : delimiters, but no other non-hex characters are permitted
int	getInteger(String name, int defaultValue)
InetAddress	getIP(String name, InetAddress defaultValue)
int	getLineCount()
long	getLong(String name, long defaultValue)
URI	getURI(String name, String defaultValue)
int	getVariableCount()
protected void	hook_added(String name, String newValue)
protected void	hook_changed(String name, String oldValue, String newValue)
protected void	hook_cleared()
protected void	hook_loaded()
protected void	hook_merge_begin()
protected void	hook_merge_complete()
protected void	hook_removed(String name)
protected void	hook_saved()
Iterator<String>	keyIterator()
Set<String>	keySet()
void	load()
void	load(File file)
void	load(InputStream is)
void	load(Reader r)
void	load(Map<String,String> map)
void	load(Properties p)
void	makeReadOnly()	Make this PropertyFile object read-only
void	merge(PropertyFile other)	Merges another PropertyFile into this PropertyFile, overwriting any conflicting properties with the value from other
void	merge(PropertyFile other, IMergeConflictResolver conflictResolver)	Merges another PropertyFile into this PropertyFile, using an optional merge conflict resolver If no merge conflict resolver is specified then the default will be that the properties from other will overwrite the local properties
void	merge(Properties other)	Merges another PropertyFile into this PropertyFile, overwriting any conflicting properties with the value from other
void	merge(Properties other, IMergeConflictResolver conflictResolver)	Merges another PropertyFile into this PropertyFile, using an optional merge conflict resolver If no merge conflict resolver is specified then the default will be that the properties from other will overwrite the local properties
static PropertyFile	openResource(ClassLoader classloader, URL resource, String fileName)
static PropertyFile	readOnly(File filename)	Creates a read-only version of a property file Fails if the file does not exist.
static PropertyFile	readOnlyUnion(PropertyFile... files)	Construct a new read-only PropertyFile which merges the contents of a number of other PropertyFile objects Null PropertyFiles are ignored.
static PropertyFile	readOnlyUnion(File... filenames)	Creates a read-only union of a number of property files If any property file is null or the file it points to does not exist then it is ignored
void	remove(String name)
void	save()
void	save(File f, String comment)
void	save(OutputStream os)
void	save(String comment)
void	save(String comment, OutputStream os)
void	save(String comment, Writer w)
String	set(String name, int value)
String	set(String name, long value)
String	set(String name, String value)
String	setBase64(String name, byte[] value)
void	setFile(File file)
void	setForceNameValueDelimiterWhitespace(boolean value)
String	setHex(String name, byte[] value)
Map<String,String>	toMap()	Converts the name/value pairs stored in this PropertyFile to a Map of key/value pairs
Properties	toProperties()	Converts the name/value pairs stored in this PropertyFile to the Java Properties propertyfile type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

f

protected File f

readOnly

protected boolean readOnly

caseSensitive

protected boolean caseSensitive

forceNameValueDelimiterWhitespace

protected boolean forceNameValueDelimiterWhitespace

entries

protected List<PropertyFile.Entry> entries

vars

protected Map<String,PropertyFile.NameValuePair> vars

dirty

protected boolean dirty

Constructor Detail

PropertyFile

public PropertyFile(File fileName)
             throws IOException

Throws:

IOException

PropertyFile

public PropertyFile(File fileName,
                    boolean caseSensitive)
             throws IOException

Throws:

IOException

PropertyFile

public PropertyFile()

PropertyFile

public PropertyFile(URL url)
             throws IOException

Throws:

IOException

PropertyFile

public PropertyFile(InputStream is,
                    boolean caseSensitive)
             throws IOException

Throws:

IOException

PropertyFile

public PropertyFile(Reader r)
             throws IOException

Throws:

IOException

PropertyFile

public PropertyFile(Reader r,
                    boolean caseSensitive)
             throws IOException

Throws:

IOException

PropertyFile

public PropertyFile(InputStream is)
             throws IOException

Throws:

IOException

PropertyFile

public PropertyFile(Properties p)

PropertyFile

public PropertyFile(Properties p,
                    boolean caseSensitive)

PropertyFile

public PropertyFile(Map<String,String> map)

Method Detail

find

public static PropertyFile find()

find

public static PropertyFile find(String fileName)

find

public static PropertyFile find(ClassLoader classloader,
                                String... fileNames)

Find a property file

Parameters:

classloader -

fileName -

Returns:

fromString

public static PropertyFile fromString(String contents)

fromString

public static PropertyFile fromString(String contents,
                                      String filename)

openResource

public static PropertyFile openResource(ClassLoader classloader,
                                        URL resource,
                                        String fileName)

findAll

public static PropertyFile[] findAll(String name)

Find all property files by the name name by searching the classloader that owns PropertyFile

Parameters:

name -

Returns:

findAll

public static PropertyFile[] findAll(ClassLoader loader,
                                     String name)

Find all property files by the name name by searching the specified classloader

Parameters:

loader -

name -

Returns:

toProperties

public Properties toProperties()

Converts the name/value pairs stored in this PropertyFile to the Java Properties propertyfile type

Returns:

a Properties representing the data (but not the comments, etc) in this file

toMap

public Map<String,String> toMap()

Converts the name/value pairs stored in this PropertyFile to a Map of key/value pairs

Returns:

a Map representing the data (but not the comments, etc) in this file

getCaseSensitive

public boolean getCaseSensitive()

getFile

public File getFile()

setFile

public void setFile(File file)

setForceNameValueDelimiterWhitespace

public void setForceNameValueDelimiterWhitespace(boolean value)

getForceNameValueDelimiterWhitespace

public boolean getForceNameValueDelimiterWhitespace()

load

public void load()
          throws IOException

Throws:

IOException

load

public void load(Map<String,String> map)

load

public void load(Properties p)

load

public void load(File file)
          throws IOException

Throws:

IOException

load

public void load(InputStream is)
          throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

save

public void save(File f,
                 String comment)
          throws IOException

Throws:

IOException

save

public void save(OutputStream os)
          throws IOException

Throws:

IOException

save

public void save(String comment)
          throws IOException

Throws:

IOException

save

public void save(String comment,
                 OutputStream os)
          throws IOException

Throws:

IOException

merge

public void merge(PropertyFile other)

Merges another PropertyFile into this PropertyFile, overwriting any conflicting properties with the value from other

Parameters:

other - the other property file

merge

public void merge(PropertyFile other,
                  IMergeConflictResolver conflictResolver)

Merges another PropertyFile into this PropertyFile, using an optional merge conflict resolver
If no merge conflict resolver is specified then the default will be that the properties from other will overwrite the local properties

Parameters:

other - the other property file

conflictResolver -

merge

public void merge(Properties other)

Merges another PropertyFile into this PropertyFile, overwriting any conflicting properties with the value from other

Parameters:

other -

merge

public void merge(Properties other,
                  IMergeConflictResolver conflictResolver)

Merges another PropertyFile into this PropertyFile, using an optional merge conflict resolver
If no merge conflict resolver is specified then the default will be that the properties from other will overwrite the local properties

Parameters:

other - the other property file

conflictResolver -

makeReadOnly

public void makeReadOnly()

Make this PropertyFile object read-only

containsKey

public boolean containsKey(String name)

get

public String get(String name)

get

public String get(String name,
                  String defaultValue)

getIP

public InetAddress getIP(String name,
                         InetAddress defaultValue)

get

public int get(String name,
               int defaultValue)

get

public long get(String name,
                long defaultValue)

get

public boolean get(String name,
                   boolean defaultValue)

getInteger

public int getInteger(String name,
                      int defaultValue)

getBoolean

public boolean getBoolean(String name,
                          boolean defaultValue)

getLong

public long getLong(String name,
                    long defaultValue)

getURI

public URI getURI(String name,
                  String defaultValue)

getClass

public Class<?> getClass(String name,
                         Class<?> defaultValue)

getBase64

public byte[] getBase64(String name)

Get a value which is Base64 encoded

Parameters:

name -

Returns:

getBase64

public byte[] getBase64(String name,
                        byte[] defaultValue)

Get a value which is Base64 encoded and has a default value

Parameters:

name -

defaultValue -

Returns:

getHex

public byte[] getHex(String name)

Get a value which has been encoded in hexidecimal; The encoding may optionally include : delimiters, but no other non-hex characters are permitted

Parameters:

name -

Returns:

set

public String set(String name,
                  String value)

setBase64

public String setBase64(String name,
                        byte[] value)

setHex

public String setHex(String name,
                     byte[] value)

set

public String set(String name,
                  long value)

set

public String set(String name,
                  int value)

remove

public void remove(String name)

clear

public void clear()

keySet

public Set<String> keySet()

keyIterator

public Iterator<String> keyIterator()

getLineCount

public int getLineCount()

getVariableCount

public int getVariableCount()

hook_changed

protected void hook_changed(String name,
                            String oldValue,
                            String newValue)

hook_added

protected void hook_added(String name,
                          String newValue)

hook_removed

protected void hook_removed(String name)

hook_cleared

protected void hook_cleared()

hook_merge_begin

protected void hook_merge_begin()

hook_merge_complete

protected void hook_merge_complete()

hook_loaded

protected void hook_loaded()

hook_saved

protected void hook_saved()

load

public void load(Reader r)
          throws IOException

Throws:

IOException

save

public void save(String comment,
                 Writer w)
          throws IOException

Throws:

IOException

_clear

protected void _clear()

_set

protected String _set(String name,
                      String value)

_get

protected String _get(String name,
                      String defaultValue)

_get_core

protected String _get_core(String name,
                           String defaultValue)

_contains

protected boolean _contains(String name)

_rm

protected void _rm(String name)

readOnlyUnion

public static PropertyFile readOnlyUnion(File... filenames)
                                  throws IOException

Creates a read-only union of a number of property files
If any property file is null or the file it points to does not exist then it is ignored

Parameters:

filenames -

Returns:

Throws:

IOException - if an unexpected error occurs while loading a file

readOnlyUnion

public static PropertyFile readOnlyUnion(PropertyFile... files)

Construct a new read-only PropertyFile which merges the contents of a number of other PropertyFile objects
Null PropertyFiles are ignored.

Parameters:

files -

Returns:

readOnly

public static PropertyFile readOnly(File filename)
                             throws IOException

Creates a read-only version of a property file
Fails if the file does not exist.

Parameters:

filename - the filename to load

Returns:

Throws:

IOException - if the file cannot be loaded