Package io.ultreia.java4all.i18n.spi

Class I18nProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

io.ultreia.java4all.i18n.spi.I18nProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class I18nProperties
extends Properties

Extend Properties to allow alphabetical order. Encoding could also be defined but you must use this class only with Java 1.6.

Created by tchemit on 06/11/2018.

Author:

Tony Chemit - dev@tchemit.fr

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
I18nProperties()
I18nProperties(String defaultEncoding)
I18nProperties(String defaultEncoding, boolean removeHeader)
I18nProperties(String defaultEncoding, boolean removeHeader, boolean unicodeLower)
I18nProperties(Properties defaults)

Method Summary

Modifier and Type	Method	Description
Enumeration<Object>	keys()
I18nProperties	load(File src)	Load all properties from given src file using defined defaultEncoding.
I18nProperties	load(File src, String encoding)	Load Properties from src file using given defaultEncoding.
protected String	saveConvert(String theString, boolean escapeSpace, boolean escapeUnicode)
void	store(File dst)	Save properties in given dst file using defined defaultEncoding.
void	store(File dst, String encoding)	Store Properties in output file using given defaultEncoding.
void	store(OutputStream dst)	Save properties in given stream file.
void	store(OutputStream out, String comments)
void	store(Writer writer, String comments)
protected void	store0(BufferedWriter bw, String comments, boolean escUnicode)
protected void	storeEncode(OutputStream stream, String encoding)	If encoding is not the default Properties one, we will use a writer to use this custom encoding.
void	writeComments(BufferedWriter bw, String comments)

Methods inherited from class java.util.Properties

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

Methods inherited from class java.lang.Object

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

Constructor Detail

I18nProperties

public I18nProperties()

I18nProperties

public I18nProperties(String defaultEncoding)

I18nProperties

public I18nProperties(String defaultEncoding,
                      boolean removeHeader)

I18nProperties

public I18nProperties(String defaultEncoding,
                      boolean removeHeader,
                      boolean unicodeLower)

I18nProperties

public I18nProperties(Properties defaults)

Method Detail

keys

public Enumeration<Object> keys()

Overrides:

keys in class Properties

load

public I18nProperties load(File src)
                    throws IOException

Load all properties from given src file using defined defaultEncoding.

Parameters:

src - source file

Returns:

this instance

Throws:

IOException - if any io pb

See Also:

load(File, String)

load

public I18nProperties load(File src,
                           String encoding)
                    throws IOException

Load Properties from src file using given defaultEncoding. If this encoding is different from default ones ENCODING_DEFAULT, ENCODING_LATIN1 and ENCODING_ASCII. A specific Reader will be used to read the file.

Parameters:

src - File where Properties will be loaded

encoding - Encoding to use

Returns:

this instance

Throws:

IOException - for any file errors

Since:

1.3

store

public void store(File dst)
           throws IOException

Save properties in given dst file using defined defaultEncoding.

Parameters:

dst - output file

Throws:

IOException - if any io pb

See Also:

store(File, String)

store

public void store(File dst,
                  String encoding)
           throws IOException

Store Properties in output file using given defaultEncoding. If this encoding is different from default ones ENCODING_DEFAULT, ENCODING_LATIN1 and ENCODING_ASCII, a specific Writer will be used to save the file. Otherwise the default Properties behavior will escape unicode chars with \uxxxx.

Parameters:

dst - File to save Properties

encoding - Encoding to use

Throws:

IOException - for any file errors

Since:

1.3

storeEncode

protected void storeEncode(OutputStream stream,
                           String encoding)
                    throws IOException

If encoding is not the default Properties one, we will use a writer to use this custom encoding.

We must call the right method depends on encoding, for a custom one the store(Writer, String) method is used otherwise the default encoding 8859_1 must be used as superclass define it in store(OutputStream, String).

Encoding ENCODING_DEFAULT, ENCODING_LATIN1 and ENCODING_ASCII are considered as default Properties one, so the old method will be use escaping unicode chars like \uxxxx.

Parameters:

stream - OutputStream to save in

encoding - Encoding to use

Throws:

IOException - For any file errors

store

public void store(OutputStream dst)
           throws IOException

Save properties in given stream file. defaultEncoding defined will be ignored to store the properties file. The default encoding is the basic Properties one (Latin1 ISO), unicode chars will be escaped like basic store(OutputStream, String) method.

Parameters:

dst - output file

Throws:

IOException - if any io pb

store

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

Overrides:

store in class Properties

Throws:

IOException

store

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

Overrides:

store in class Properties

Throws:

IOException

store0

protected void store0(BufferedWriter bw,
                      String comments,
                      boolean escUnicode)
               throws IOException

Throws:

IOException

saveConvert

protected String saveConvert(String theString,
                             boolean escapeSpace,
                             boolean escapeUnicode)

writeComments

public void writeComments(BufferedWriter bw,
                          String comments)
                   throws IOException

Throws:

IOException