Class UTF8Properties

java.lang.Object

java.util.Dictionary<Object,Object>

java.util.Hashtable<Object,Object>

java.util.Properties

aQute.lib.utf8properties.UTF8Properties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class UTF8Properties
extends Properties

Properties were by default read as ISO-8859-1 characters. However, in the last 10 years most builds use UTF-8. Since this is in general a global setting, it is very awkward to use ISO-8859-1. In general, it is not often a problem since most of Java is written with the basic ASCII encoding. However, we want to do this right. So in bnd we generally use this UTF-8 Properties class. This class always writes UTF-8. However, it will try to read UTF-8 first. If this fails, it will try ISO-8859-1, and the last attempt is the platform default.

This class can (and probably should) be used anywhere a Properties class is used.

See Also:

• Serialized Form

Field Summary

Fields inherited from class Properties

defaults

Constructor Summary

Constructors

Constructor	Description
UTF8Properties()
UTF8Properties(File file)
UTF8Properties(File file, Reporter reporter)
UTF8Properties(File file, Reporter reporter, String[] syntaxHeaders)
UTF8Properties(File file, String[] syntaxHeaders)
UTF8Properties(Properties p)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getProvenance(String key)	Get the provenance of the given key if set
void	load(File file, Reporter reporter)
void	load(File file, Reporter reporter, String[] syntaxHeaders)
void	load(File file, Reporter reporter, Collection<String> syntaxHeaders)
void	load(InputStream in)
void	load(InputStream in, File file, Reporter reporter)
void	load(InputStream in, File file, Reporter reporter, String[] syntaxHeaders)
void	load(InputStream in, File file, Reporter reporter, Collection<String> syntaxHeaders)
void	load(Reader r)
void	load(String source, File file, Reporter reporter)
void	load(String source, File file, Reporter reporter, String[] syntaxHeaders)
void	load(String source, File file, Reporter reporter, Collection<String> syntaxHeaders)
void	load(String source, File file, Reporter reporter, Collection<String> syntaxHeaders, String provenance)
void	load(Properties properties, boolean overwriteIfPresent)	Load the properties from a properties.
void	putAll(Map<?,?> t)
Object	remove(Object key)
UTF8Properties	replaceAll(String pattern, String replacement)	Replace a string in all the values.
UTF8Properties	replaceHere(File file)	Replace the string "${.}" in all the values with the path of the specified file.
Object	setProperty(String key, String value, String provenance)
void	setProvenance(String provenance)	Set the provenance on all current keys
UTF8Properties	setProvenance(String key, String provenance)	Set the provenance of the given key
void	store(File file)
void	store(OutputStream out)
void	store(OutputStream out, String msg)
void	store(Writer writer, String msg)

Methods inherited from class Properties

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, loadFromXML, merge, propertyNames, put, putIfAbsent, rehash, remove, replace, replace, replaceAll, save, setProperty, size, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UTF8Properties

public UTF8Properties(Properties p)

UTF8Properties

public UTF8Properties(File file,
 String[] syntaxHeaders)
               throws Exception

Throws:

Exception

UTF8Properties

public UTF8Properties(File file)
               throws Exception

Throws:

Exception

UTF8Properties

public UTF8Properties(File file,
 Reporter reporter,
 String[] syntaxHeaders)
               throws Exception

Throws:

Exception

UTF8Properties

public UTF8Properties(File file,
 Reporter reporter)
               throws Exception

Throws:

Exception

UTF8Properties

public UTF8Properties()

Method Details

load

public void load(InputStream in,
 File file,
 Reporter reporter,
 String[] syntaxHeaders)
          throws IOException

Throws:

IOException

load

public void load(InputStream in,
 File file,
 Reporter reporter,
 Collection<String> syntaxHeaders)
          throws IOException

Throws:

IOException

load

public void load(InputStream in,
 File file,
 Reporter reporter)
          throws IOException

Throws:

IOException

load

public void load(String source,
 File file,
 Reporter reporter)
          throws IOException

Throws:

IOException

load

public void load(String source,
 File file,
 Reporter reporter,
 String[] syntaxHeaders)
          throws IOException

Throws:

IOException

load

public void load(String source,
 File file,
 Reporter reporter,
 Collection<String> syntaxHeaders)
          throws IOException

Throws:

IOException

load

public void load(String source,
 File file,
 Reporter reporter,
 Collection<String> syntaxHeaders,
 String provenance)
          throws IOException

Throws:

IOException

load

public void load(File file,
 Reporter reporter,
 String[] syntaxHeaders)
          throws Exception

Throws:

Exception

load

public void load(File file,
 Reporter reporter,
 Collection<String> syntaxHeaders)
          throws Exception

Throws:

Exception

load

public void load(File file,
 Reporter reporter)
          throws Exception

Throws:

Exception

load

public void load(InputStream in)
          throws IOException

Overrides:

load in class Properties

Throws:

IOException

load

public void load(Reader r)
          throws IOException

Overrides:

load in class Properties

Throws:

IOException

store

public void store(Writer writer,
 String msg)
           throws IOException

Overrides:

store in class Properties

Throws:

IOException

store

public void store(OutputStream out,
 String msg)
           throws IOException

Overrides:

store in class Properties

Throws:

IOException

store

public void store(File file)
           throws IOException

Throws:

IOException

store

public void store(OutputStream out)
           throws IOException

Throws:

IOException

replaceAll

public UTF8Properties replaceAll(String pattern,
 String replacement)

Replace a string in all the values. This can be used to preassign variables that change. For example, the base directory ${.} for a loaded properties.

Returns:

A new UTF8Properties with the replacement.

replaceHere

public UTF8Properties replaceHere(File file)

Replace the string "${.}" in all the values with the path of the specified file.

Returns:

A new UTF8Properties with the replacement.

setProperty

public Object setProperty(String key,
 String value,
 String provenance)

remove

public Object remove(Object key)

Specified by:

remove in interface Map<Object,Object>

Overrides:

remove in class Properties

getProvenance

public Optional<String> getProvenance(String key)

Get the provenance of the given key if set

Parameters:

key - the key

setProvenance

public UTF8Properties setProvenance(String key,
 String provenance)

Set the provenance of the given key

Parameters:

key - the key

provenance - the provenance, maybe null to remove

load

public void load(Properties properties,
 boolean overwriteIfPresent)

Load the properties from a properties. If the properties is a UTF8Properties, we also copy the provenance.

Parameters:

properties - the properties

overwriteIfPresent - overwrite an exissting value in this properties

putAll

public void putAll(Map<?,?> t)

Specified by:

putAll in interface Map<Object,Object>

Overrides:

putAll in class Properties

setProvenance

public void setProvenance(String provenance)

Set the provenance on all current keys

Parameters:

provenance -