properties – github.com/magiconair/properties Index | Examples | Files

package properties

import "github.com/magiconair/properties"

properties provides functions for reading and writing ISO-8859-1 and UTF-8 encoded .properties files and has support for recursive property expansion.

Java properties files are ISO-8859-1 encoded and use Unicode literals for characters outside the ISO character set. Unicode literals can be used in UTF-8 encoded properties files but aren't necessary.

To load a single properties file use MustLoadFile(): 

p := properties.MustLoadFile(filename, properties.UTF8)

To load multiple properties files use MustLoadFiles() which loads the files in the given order and merges the result. Missing properties files can be ignored if the 'ignoreMissing' flag is set to true.

Filenames can contain environment variables which are expanded before loading. 

f1 := "/etc/myapp/myapp.conf"
f2 := "/home/${USER}/myapp.conf"
p := MustLoadFiles([]string{f1, f2}, properties.UTF8, true)

All of the different key/value delimiters ' ', ':' and '=' are supported as well as the comment characters '!' and '#' and multi-line values. 

! this is a comment
# and so is this

# the following expressions are equal
key value
key=value
key:value
key = value
key : value
key = val\
      ue

Property expansion is recursive and circular references and malformed expressions are not allowed and cause an error. Expansion of environment variables is supported. 

# standard property
key = value

# property expansion: key2 = value
key2 = ${key}

# recursive expansion: key3 = value
key3 = ${key2}

# circular reference (error)
key = ${key}

# malformed expression (error)
key = ${ke

# refers to the users' home dir
home = ${HOME}

# local key takes precendence over env var: u = foo
USER = foo
u = ${USER}

The default property expansion format is ${key} but can be changed by setting different pre- and postfix values on the Properties object. 

p := properties.NewProperties()
p.Prefix = "#["
p.Postfix = "]#"

Properties provides convenience functions for getting typed values with default values if the key does not exist or the type conversion failed. 

# Returns true if the value is either "1", "on", "yes" or "true"
# Returns false for every other value and the default value if
# the key does not exist.
v = p.GetBool("key", false)

# Returns the value if the key exists and the format conversion
# was successful. Otherwise, the default value is returned.
v = p.GetInt64("key", 999)
v = p.GetUint64("key", 999)
v = p.GetFloat64("key", 123.0)
v = p.GetString("key", "def")
v = p.GetDuration("key", 999)

Properties provides several MustXXX() convenience functions which will terminate the app if an error occurs. The behavior of the failure is configurable and the default is to call log.Fatal(err). To have the MustXXX() functions panic instead of logging the error set a different ErrorHandler before you use the Properties package. 

properties.ErrorHandler = properties.PanicHandler

# Will panic instead of logging an error
p := properties.MustLoadFile("config.properties")

You can also provide your own ErrorHandler function. The only requirement is that the error handler function must exit after handling the error. 

  properties.ErrorHandler = func(err error) {
	     fmt.Println(err)
      os.Exit(1)
  }

  # Will write to stdout and then exit
  p := properties.MustLoadFile("config.properties")

The following documents provide a description of the properties file format.

http://en.wikipedia.org/wiki/.properties

http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load%28java.io.Reader%29

Example

Code: 

{
	// Decode some key/value pairs with expressions
	p, err := Load([]byte("key=value\nkey2=${key}"), ISO_8859_1)
	if err != nil {
		log.Fatal(err)
	}

	// Get a valid key
	if v, ok := p.Get("key"); ok {
		fmt.Println(v)
	}

	// Get an invalid key
	if _, ok := p.Get("does not exist"); !ok {
		fmt.Println("invalid key")
	}

	// Get a key with a default value
	v := p.GetString("does not exist", "some value")
	fmt.Println(v)

	// Dump the expanded key/value pairs of the Properties
	fmt.Println("Expanded key/value pairs")
	fmt.Println(p)

	// Output:
	// value
	// invalid key
	// some value
	// Expanded key/value pairs
	// key = value
	// key2 = value
}

Output:

value
invalid key
some value
Expanded key/value pairs
key = value
key2 = value

Index

Examples

Functions

func LogFatalHandler 

func LogFatalHandler(err error)

LogFatalHandler handles the error by logging a fatal error and exiting.

func PanicHandler 

func PanicHandler(err error)

PanicHandler handles the error by panicking.

Types

type Encoding 

type Encoding uint
const (
	UTF8 Encoding = 1 << iota
	ISO_8859_1
)

type ErrorHandlerFunc 

type ErrorHandlerFunc func(error)

ErrorHandlerFunc defines the type of function which handles failures of the MustXXX() functions. An error handler function must exit the application after handling the error. 

var ErrorHandler ErrorHandlerFunc = LogFatalHandler

ErrorHandler is the function which handles failures of the MustXXX() functions. The default is LogFatalHandler.

type Properties 

type Properties struct {
	// Pre-/Postfix for property expansion.
	Prefix  string
	Postfix string
	// contains filtered or unexported fields
}

func Load 

func Load(buf []byte, enc Encoding) (*Properties, error)

Load reads a buffer into a Properties struct.

Example (Iso88591)

Code: 

{
	buf := []byte("key = ISO-8859-1 value with unicode literal \\u2318 and umlaut \xE4") // 0xE4 == ä
	p, _ := Load(buf, ISO_8859_1)
	v, ok := p.Get("key")
	fmt.Println(ok)
	fmt.Println(v)
	// Output:
	// true
	// ISO-8859-1 value with unicode literal ⌘ and umlaut ä
}

Output:

true
ISO-8859-1 value with unicode literal ⌘ and umlaut ä
Example (Utf8)

Code: 

{
	p, _ := Load([]byte("key = UTF-8 value with unicode character ⌘ and umlaut ä"), UTF8)
	v, ok := p.Get("key")
	fmt.Println(ok)
	fmt.Println(v)
	// Output:
	// true
	// UTF-8 value with unicode character ⌘ and umlaut ä
}

Output:

true
UTF-8 value with unicode character ⌘ and umlaut ä

func LoadFile 

func LoadFile(filename string, enc Encoding) (*Properties, error)

LoadFile reads a file into a Properties struct.

func LoadFiles 

func LoadFiles(filenames []string, enc Encoding, ignoreMissing bool) (*Properties, error)

LoadFiles reads multiple files in the given order into a Properties struct. If 'ignoreMissing' is true then non-existent files will not be reported as error.

func MustLoadFile 

func MustLoadFile(filename string, enc Encoding) *Properties

MustLoadFile reads a file into a Properties struct and panics on error.

func MustLoadFiles 

func MustLoadFiles(filenames []string, enc Encoding, ignoreMissing bool) *Properties

MustLoadFiles reads multiple files in the given order into a Properties struct and panics on error. If 'ignoreMissing' is true then non-existent files will not be reported as error.

func NewProperties 

func NewProperties() *Properties

NewProperties creates a new Properties struct with the default configuration for "${key}" expressions.

func (*Properties) Get 

func (p *Properties) Get(key string) (value string, ok bool)

Get returns the expanded value for the given key if exists. Otherwise, ok is false.

func (*Properties) GetBool 

func (p *Properties) GetBool(key string, def bool) bool

GetBool checks if the expanded value is one of '1', 'yes', 'true' or 'on' if the key exists. The comparison is case-insensitive. If the key does not exist the default value is returned.

Example

Code: 

{
	var input = `
	key=1
	key2=On
	key3=YES
	key4=true`
	p, _ := Load([]byte(input), ISO_8859_1)
	fmt.Println(p.GetBool("key", false))
	fmt.Println(p.GetBool("key2", false))
	fmt.Println(p.GetBool("key3", false))
	fmt.Println(p.GetBool("key4", false))
	fmt.Println(p.GetBool("keyX", false))
	// Output:
	// true
	// true
	// true
	// true
	// false
}

Output:

true
true
true
true
false

func (*Properties) GetDuration 

func (p *Properties) GetDuration(key string, def time.Duration) time.Duration

GetDuration parses the expanded value as an time.Duration if the key exists. If key does not exist or the value cannot be parsed the default value is returned.

func (*Properties) GetFloat64 

func (p *Properties) GetFloat64(key string, def float64) float64

GetFloat64 parses the expanded value as a float64 if the key exists. If key does not exist or the value cannot be parsed the default value is returned.

func (*Properties) GetInt 

func (p *Properties) GetInt(key string, def int) int

GetInt parses the expanded value as an int if the key exists. If key does not exist or the value cannot be parsed the default value is returned. If the value does not fit into an int the function panics with an out of range error.

func (*Properties) GetInt64 

func (p *Properties) GetInt64(key string, def int64) int64

GetInt64 parses the expanded value as an int64 if the key exists. If key does not exist or the value cannot be parsed the default value is returned.

func (*Properties) GetString 

func (p *Properties) GetString(key, def string) string

GetString returns the expanded value for the given key if exists or the default value otherwise.

Example

Code: 

{
	p, _ := Load([]byte("key=value"), ISO_8859_1)
	v := p.GetString("another key", "default value")
	fmt.Println(v)
	// Output:
	// default value
}

Output:

default value

func (*Properties) GetUint 

func (p *Properties) GetUint(key string, def uint) uint

GetUint parses the expanded value as an uint if the key exists. If key does not exist or the value cannot be parsed the default value is returned. If the value does not fit into an int the function panics with an out of range error.

func (*Properties) GetUint64 

func (p *Properties) GetUint64(key string, def uint64) uint64

GetUint64 parses the expanded value as an uint64 if the key exists. If key does not exist or the value cannot be parsed the default value is returned.

func (*Properties) Len 

func (p *Properties) Len() int

Len returns the number of keys.

func (*Properties) MustGet 

func (p *Properties) MustGet(key string) string

MustGet returns the expanded value for the given key if exists. Otherwise, it panics.

func (*Properties) MustGetBool 

func (p *Properties) MustGetBool(key string) bool

MustGetBool checks if the expanded value is one of '1', 'yes', 'true' or 'on' if the key exists. The comparison is case-insensitive. If the key does not exist the function panics.

func (*Properties) MustGetDuration 

func (p *Properties) MustGetDuration(key string) time.Duration

MustGetDuration parses the expanded value as an time.Duration if the key exists. If key does not exist or the value cannot be parsed the function panics.

func (*Properties) MustGetFloat64 

func (p *Properties) MustGetFloat64(key string) float64

GetFloat64 parses the expanded value as a float64 if the key exists. If key does not exist or the value cannot be parsed the function panics.

func (*Properties) MustGetInt 

func (p *Properties) MustGetInt(key string) int

MustGetInt parses the expanded value as an int if the key exists. If key does not exist or the value cannot be parsed the function panics. If the value does not fit into an int the function panics with an out of range error.

func (*Properties) MustGetInt64 

func (p *Properties) MustGetInt64(key string) int64

MustGetInt64 parses the expanded value as an int if the key exists. If key does not exist or the value cannot be parsed the function panics.

func (*Properties) MustGetString 

func (p *Properties) MustGetString(key string) string

MustGetString returns the expanded value for the given key if exists or panics otherwise.

func (*Properties) MustGetUint 

func (p *Properties) MustGetUint(key string) uint

MustGetUint parses the expanded value as an int if the key exists. If key does not exist or the value cannot be parsed the function panics. If the value does not fit into an int the function panics with an out of range error.

func (*Properties) MustGetUint64 

func (p *Properties) MustGetUint64(key string) uint64

MustGetUint64 parses the expanded value as an int if the key exists. If key does not exist or the value cannot be parsed the function panics.

func (*Properties) Set 

func (p *Properties) Set(key, value string) (prev string, ok bool, err error)

Set sets the property key to the corresponding value. If a value for key existed before then ok is true and prev contains the previous value. If the value contains a circular reference or a malformed expression then an error is returned.

func (*Properties) String 

func (p *Properties) String() string

String returns a string of all expanded 'key = value' pairs.

func (*Properties) Write 

func (p *Properties) Write(w io.Writer, enc Encoding) (int, error)

Write writes all unexpanded 'key = value' pairs to the given writer.

Bugs

☞ Set() does not check for invalid unicode literals since this is currently handled by the lexer.

☞ Write() does not allow to configure the newline character. Therefore, on Windows LF is used.

Source Files

doc.go lex.go load.go parser.go properties.go rangecheck.go

Version
v1.3.0
Published
Mar 18, 2014
Platform
js/wasm
Imports
11 packages
Last checked
now –

Tools for package owners.