Package eu.bandm.tools.util.xml

Class NamespaceName2String

java.lang.Object

java.util.AbstractMap<NamespaceName,String>

eu.bandm.tools.util.xml.NamespaceName2String

All Implemented Interfaces:

Map<NamespaceName,String>

public class NamespaceName2String
extends AbstractMap<NamespaceName,String>

Maintains a map from to String, and reads different file formats. FIXME delegatin to ".map" raus, use simply "extends HashMap<NamespaceName,String>"

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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
Map<NamespaceName,String>	map	The stored data.

Constructor Summary

Constructors

Constructor	Description
NamespaceName2String()	Construct an empty map.
NamespaceName2String(Map<NamespaceName,String> data)	Constructs a map with the given data.

Method Summary

Modifier and Type	Method	Description
boolean	containsPattern(String patternMarker)	Returns whether the pattern marker is contained anywhere in the values of this map.
void	divideValues(Predicate<String> test, NamespaceName2String yes, NamespaceName2String no)	Pipe all entries in this instance according to the result of test to their values.
void	dump(PrintStream p)	Print this map in a symbolic representation to the print stream.
Set<Map.Entry<NamespaceName,String>>	entrySet()
boolean	equals(@Opt Object o)	Directly delegate to the implementing map.
<A, B> void	fillFromOptions(MessageReceiver<SimpleMessage<?>> msg, @Opt List<A> files, @Opt List<B> pairs)	Add the pairs from the files and then the pairs directly contained in a command line option.
void	from(File f)	Create a map reading the data from the given source.
void	from(File f, Charset encoding)	Create a map reading the data from the given source.
void	from(InputStream s, Charset encoding)	Create a map reading the data from the given source.
void	from(Reader r)	Create a map reading the data from the given source.
void	from(String k, String v)	Add a key/value pair to the map.
int	hashCode()	Directly delegate to the implementing map.
String	put(NamespaceName k, String v)
NamespaceName2String	replacePattern(String patternMarker, String value)	Return a new copy in the data of which all occurences of the patternMarker are replaced by the given value.

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, get, isEmpty, keySet, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Details

map

public Map<NamespaceName,String> map

The stored data. Can freely be manipulated from outside without harm, but the methods provided here are more convenient.

Constructor Details

NamespaceName2String

public NamespaceName2String()

Construct an empty map. (This constructor is required by collections framework convention.)

NamespaceName2String

public NamespaceName2String(Map<NamespaceName,String> data)

Constructs a map with the given data.

Method Details

equals

public boolean equals(@Opt
 @Opt Object o)

Directly delegate to the implementing map.

Specified by:

equals in interface Map<NamespaceName,String>

Overrides:

equals in class AbstractMap<NamespaceName,String>

hashCode

public int hashCode()

Directly delegate to the implementing map.

Specified by:

hashCode in interface Map<NamespaceName,String>

Overrides:

hashCode in class AbstractMap<NamespaceName,String>

from

public void from(File f,
 Charset encoding)
          throws IOException

Create a map reading the data from the given source. For details of the file format see from(reader).

Throws:

IOException

from

public void from(File f)
          throws IOException

Create a map reading the data from the given source. Use StandardCharsets.UTF_8 as encoding. For details of the file format see from(reader).

Throws:

IOException

from

public void from(InputStream s,
 Charset encoding)
          throws IOException

Create a map reading the data from the given source. For details of the file format see from(reader).

Throws:

IOException

from

public void from(Reader r)
          throws IOException

Create a map reading the data from the given source. Each line must start with a namespace name used as a key. The key is limited by a single blank. It must follow the inline syntax, see NamespaceName.parseInlineURIFormat(java.lang.String). The rest of the line, after that separating single blank, is the value stored with the key. With duplicate keys, the later overrides the earlier without notice.

Empty lines or lines starting with a "#" are ignored as comments.

Throws:

IOException

from

public void from(String k,
 String v)
          throws IllegalArgumentException

Add a key/value pair to the map. The key must follow the inline syntax, see NamespaceName.parseInlineURIFormat(java.lang.String). With double keys, the later overrides the earlier without notice.

Parameters:

k - the key must be parseable by NamespaceName#parseInlineURIFormat().

Throws:

IllegalArgumentException

dump

public void dump(PrintStream p)

Print this map in a symbolic representation to the print stream.

entrySet

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

Specified by:

entrySet in interface Map<NamespaceName,String>

Specified by:

entrySet in class AbstractMap<NamespaceName,String>

put

public String put(NamespaceName k,
 String v)

Specified by:

put in interface Map<NamespaceName,String>

Overrides:

put in class AbstractMap<NamespaceName,String>

containsPattern

public boolean containsPattern(String patternMarker)

Returns whether the pattern marker is contained anywhere in the values of this map. (Prototypical use with xslt style-sheet parameters.)

replacePattern

public NamespaceName2String replacePattern(String patternMarker,
 String value)

Return a new copy in the data of which all occurences of the patternMarker are replaced by the given value. (Prototypical use with xslt style-sheet parameters.)

divideValues

public void divideValues(Predicate<String> test,
 NamespaceName2String yes,
 NamespaceName2String no)

Pipe all entries in this instance according to the result of test to their values.

Parameters:

test - criterium for the division

yes - where to copy the entry in case of a positive test result

no - where to copy the entry in case of a negative test result

fillFromOptions

public <A,
B> void fillFromOptions(MessageReceiver<SimpleMessage<?>> msg,
 @Opt
 @Opt List<A> files,
 @Opt
 @Opt List<B> pairs)

Add the pairs from the files and then the pairs directly contained in a command line option. A file later in the list has priority over its predecessors; explicit assignments from the command line option have priority over the files' contents.

Since the options compiler generates totally independent classes for each application, this code must use reflection to get the getter methods. Exceptions caused by reflection application are translated to error messages.

Parameters:

A - the type of value objects. Must provide a method "get_0()" which delivers a String which is a file name.

B - the type of value objects. Must provide methods "get_0()" and "get_1()" which deliver the NamespaceName key and a String value.