read properties file into map (filename a, [encoding b], map c)

Gruppe

Basic Functions


Diese Funktion liest vom lokalen Dateisystem eine Properties-Datei und fügt die Properties als Schlüssel-Wert-Paare in ein Named Map Objekt ein. Die Map wird vorher nicht geleert. Der Name der Map muss in Parameter c angegeben werden; es existiert kein Defaultwert. Wenn bisher keine Named Map mit diesem Namen existierte, wird sie erzeugt.

Pflichtparameter a muss den absoluten oder relativen Pfad zur Properties-Datei enthalten. Falls die Datei nicht existiert, erfolgt ein Fehlerabbruch. Per Definition hat eine Properties-Datei das Zeichen-Encoding ISO-8859-1. Mit dem optionalen Parameter b kann aber auch ein abweichendes Encoding angegeben werden.

Der Rückgabewert der Funktion ist die Anzahl der Schlüssel-Wert-Paare, die nach dem Einfügen der Properties in der Map sind.

Parameterbeschreibung

Parameter

Beschreibung

a

Dateiname.

b

(optional) Encoding. Default: 8859_1

c

Name der Map.

Beispiele

Angenommen, die Named Map mit dem Namen ABC war vor Ausführung der Funktion leer oder nicht vorhanden und die Datei ./conf/xyz.properties ist eine Properties-Datei im Encoding 8859_1 mit drei Properties mit verschiedenen Schlüsseln.

Parameter a

Parameter b

Parameter c

Ergebnis

./conf/xyz.properties

ABC

3

Das eigentliche Ergebnis der Funktionsausführung ist es, dass nun ein Named-Map Objekt mit dem Namen ABC existiert, das drei Schlüssel-Wert-Paare enthält.