Package de.mhus.lib.core

Class MProperties

java.lang.Object

de.mhus.lib.core.MLog

de.mhus.lib.core.lang.MObject

de.mhus.lib.core.AbstractProperties

de.mhus.lib.core.MProperties

All Implemented Interfaces:

ILog, IProperties, IReadProperties, MNlsProvider, Nls, Externalizable, Serializable, Iterable<Map.Entry<String,Object>>, Map<String,Object>

Direct Known Subclasses:

LogProperties, PemBlockModel

public class MProperties
extends AbstractProperties
implements Externalizable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected Properties	properties

Constructor Summary

Constructors

Constructor	Description
MProperties()
MProperties(IProperties in)
MProperties(IReadProperties in)
MProperties(String... values)
MProperties(Dictionary<?,?> config)
MProperties(Map<?,?> in)
MProperties(Properties properties)

Method Summary

Modifier and Type	Method	Description
static void	appendToMap(Map<?,?> p, String para)
static void	appendToMap(Map<?,?> p, String para, char keySeparator, char typeSeparator)
void	clear()
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
static MProperties	explodeToMProperties(String properties)	This will handle the strings like properties.
static MProperties	explodeToMProperties(String[] properties)	This will handle the strings like properties.
static MProperties	explodeToMProperties(String[] properties, char keySeparator, char typeSeparator)	This will handle the strings like properties.
static MProperties	explodeToMProperties(String[] properties, char keySeparator, char typeSeparator, int offset, int length)
static MProperties	explodeToMProperties(String[] properties, int offset, int length)
static MProperties	explodeToOptions(String properties)	This will handle the strings like options.
static MProperties	explodeToOptions(String[] properties)	This will handle the strings like options.
static MProperties	explodeToOptions(String[] properties, char separator)	This will handle the strings like options.
static Properties	explodeToProperties(String[] properties)	This will handle the strings like properties.
Object	getProperty(String name)	Overwrite this function to provide values in string format.
boolean	isEditable()	Overwrite this function and return true if the property set can be edited.
static boolean	isFunctional(String key)	Return true if key starts with underscore but not with two underscores.
boolean	isProperty(String name)	Return true if the property exists.
Set<String>	keys()
static MProperties	load(File f)
static MProperties	load(InputStream inStream)
static MProperties	load(Reader is)
static MProperties	load(String fileName)
static MProperties	loadOrEmpty(File f)
void	putAll(String prefix, Map<?,?> map)
void	readExternal(ObjectInput in)
void	removeProperty(String key)	Remove the property field in the list of properties.
boolean	save(File file)
boolean	save(OutputStream out)
void	setProperty(String key, Object value)	Overwrite this function to allow changes in properties.
int	size()
static IProperties	toIProperties(IReadProperties properties)
static MProperties	toMProperties(IReadProperties properties)
String	toString()
static void	updateFunctional(Map<String,Object> in)	In this scenario we separate between functional parameters (starting with one underscore) and data.
Collection<Object>	values()
void	writeExternal(ObjectOutput out)

Methods inherited from class de.mhus.lib.core.AbstractProperties

containsKey, get, getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getFormatted, getInt, getLong, getNumber, getString, getString, isEmpty, iterator, keySet, put, putAll, putReadProperties, remove, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, setString, toMap

Methods inherited from class de.mhus.lib.core.lang.MObject

getNls, nls

Methods inherited from class de.mhus.lib.core.MLog

log

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

properties

protected Properties properties

Constructor Detail

MProperties

public MProperties()

MProperties

public MProperties(String... values)

MProperties

public MProperties(Dictionary<?,?> config)

MProperties

public MProperties(Map<?,?> in)

MProperties

public MProperties(IReadProperties in)

MProperties

public MProperties(IProperties in)

MProperties

public MProperties(Properties properties)

Method Detail

getProperty

public Object getProperty(String name)

Description copied from class: AbstractProperties

Overwrite this function to provide values in string format.

Specified by:

getProperty in interface IReadProperties

Specified by:

getProperty in class AbstractProperties

Returns:

null if the property not exists or the property value.

isProperty

public boolean isProperty(String name)

Description copied from class: AbstractProperties

Return true if the property exists.

Specified by:

isProperty in interface IReadProperties

Specified by:

isProperty in class AbstractProperties

Returns:

if exists

removeProperty

public void removeProperty(String key)

Description copied from class: AbstractProperties

Remove the property field in the list of properties.

Specified by:

removeProperty in interface IProperties

Specified by:

removeProperty in class AbstractProperties

setProperty

public void setProperty(String key,
                        Object value)

Description copied from class: AbstractProperties

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class AbstractProperties

isEditable

public boolean isEditable()

Description copied from class: AbstractProperties

Overwrite this function and return true if the property set can be edited.

Specified by:

isEditable in interface IProperties

Specified by:

isEditable in class AbstractProperties

Returns:

if is editable

keys

public Set<String> keys()

Specified by:

keys in interface IReadProperties

Specified by:

keys in class AbstractProperties

Returns:

the keys

toString

public String toString()

Overrides:

toString in class MObject

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

explodeToOptions

public static MProperties explodeToOptions(String properties)

This will handle the strings like options. Means a string without separator will handled as key and set to true. e.g. val1&val2&a=b will be val1=true, val2=true, a=b

Parameters:

properties - Rfc1738 (Url Encode) encoded string

Returns:

The MProperties

explodeToOptions

public static MProperties explodeToOptions(String[] properties)

This will handle the strings like options. Means a string without separator will handled as key and set to true. e.g. [val1, val2, a=b] will be val1=true, val2=true, a=b

Parameters:

properties -

Returns:

The MProperties

explodeToMProperties

public static MProperties explodeToMProperties(String properties)

This will handle the strings like properties. Means a string without separator will be stored as value with an increasing key as integer, e.g. val1&val2&a=b will be 0=val1, 1=val2, a=b

Parameters:

properties - Rfc1738 (Url Encoded) encoded string

Returns:

The MProperties

explodeToMProperties

public static MProperties explodeToMProperties(String[] properties)

This will handle the strings like properties. Means a string without separator will be stored as value with an increasing key as integer, e.g. [val1, val2, a=b] will be 0=val1, 1=val2, a=b

Parameters:

properties -

Returns:

The MProperties

explodeToMProperties

public static MProperties explodeToMProperties(String[] properties,
                                               int offset,
                                               int length)

explodeToOptions

public static MProperties explodeToOptions(String[] properties,
                                           char separator)

This will handle the strings like options. Means a string without separator will handled as key and set to true. e.g. [val1, val2, a=b] will be val1=true, val2=true, a=b

Parameters:

properties -

separator -

Returns:

The MProperties

explodeToMProperties

public static MProperties explodeToMProperties(String[] properties,
                                               char keySeparator,
                                               char typeSeparator)

This will handle the strings like properties. Means a string without separator will be stored as value with an increasing key as integer, e.g. [val1, val2, a=b] will be 0=val1, 1=val2, a=b

Parameters:

properties -

keySeparator -

typeSeparator -

Returns:

The MProperties

explodeToMProperties

public static MProperties explodeToMProperties(String[] properties,
                                               char keySeparator,
                                               char typeSeparator,
                                               int offset,
                                               int length)

explodeToProperties

public static Properties explodeToProperties(String[] properties)

This will handle the strings like properties. Means a string without separator will be stored as value with an increasing key as integer, e.g. [val1, val2, a=b] will be 0=val1, 1=val2, a=b

Parameters:

properties -

Returns:

The Properties

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface IReadProperties

Specified by:

containsValue in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface IReadProperties

Specified by:

values in interface Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface IReadProperties

Specified by:

entrySet in interface Map<String,Object>

load

public static MProperties load(String fileName)

loadOrEmpty

public static MProperties loadOrEmpty(File f)

load

public static MProperties load(File f)

load

public static MProperties load(InputStream inStream)
                        throws IOException

Throws:

IOException

load

public static MProperties load(Reader is)

putAll

public void putAll(String prefix,
                   Map<?,?> map)

size

public int size()

Specified by:

size in interface Map<String,Object>

Specified by:

size in class AbstractProperties

save

public boolean save(File file)
             throws IOException

Throws:

IOException

save

public boolean save(OutputStream out)
             throws IOException

Throws:

IOException

clear

public void clear()

Specified by:

clear in interface IProperties

Specified by:

clear in interface Map<String,Object>

updateFunctional

public static void updateFunctional(Map<String,Object> in)

In this scenario we separate between functional parameters (starting with one underscore) and data. Using this method functional parameters can be cascaded over multiple levels. Will remove all parameters starting with underscore and not two underscore and remove one underscore from thoos with more underscores. _test will be removed __test will be _test after update

Parameters:

in -

isFunctional

public static boolean isFunctional(String key)

Return true if key starts with underscore but not with two underscores.

Parameters:

key -

Returns:

true if actual internal

toIProperties

public static IProperties toIProperties(IReadProperties properties)

toMProperties

public static MProperties toMProperties(IReadProperties properties)

appendToMap

public static void appendToMap(Map<?,?> p,
                               String para)

appendToMap

public static void appendToMap(Map<?,?> p,
                               String para,
                               char keySeparator,
                               char typeSeparator)