Class ZConfig

java.lang.Object

org.zeromq.ZConfig

public class ZConfig
extends Object

Lets applications load, work with, and save configuration files. This is a minimal implementation of the ZeroMQ Property Language, which is a simple structured text format for configuration files.

Here is an example ZPL stream and corresponding config structure:

       context
           iothreads = 1
           verbose = 1      #   Ask for a trace
       main
           type = zqueue    #  ZMQ_DEVICE type
           frontend
               option
                   hwm = 1000
                   swap = 25000000     #  25MB
               bind = 'inproc://addr1'
               bind = 'ipc://addr2'
           backend
               bind = inproc://addr3
  

  
   root                    Down = child
   |                     Across = next
   v
   context-->main
   |         |
   |         v
   |       type=queue-->frontend-->backend
   |                      |          |
   |                      |          v
   |                      |        bind=inproc://addr3
   |                      v
   |                    option-->bind=inproc://addr1-->bind=ipc://addr2
   |                      |
   |                      v
   |                    hwm=1000-->swap=25000000
   v
   iothreads=1-->verbose=false

It can put and get values and save and load them to disk:

ZConfig conf = new ZConfig("root", null);
conf.put("/curve/public-key","abcdef");
String val = conf.get("/curve/public-key","fallback-defaultkey");
conf.save("test.cert");
ZConfig loaded = ZConfig.load("test.cert");

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	ZConfig.IVisitor
static class	ZConfig.ReadException

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,ZConfig>	children
private final List<String>	comments
private static final String	LEFT
private final String	name
private static final Pattern	PTRN_CONTAINER
private static final Pattern	PTRN_KEYVALUE
private String	value

Constructor Summary

Constructors

Constructor	Description
ZConfig(String name, ZConfig parent)

Method Summary

Modifier and Type	Method	Description
void	addComment(String comment)	add comment
private static ZConfig	child(ZConfig parent, Matcher matcher, int currentLevel, String currentLine, AtomicInteger lineNumber)
private void	fillValues(String prefix, Map<String,String> values)
ZConfig	getChild(String name)
String	getName()
String	getValue(String path)
String	getValue(String path, String defaultValue)
Map<String,String>	getValues()
static ZConfig	load(String filename)
private static ZConfig	load(ZConfig parent, List<String> content, int currentLevel, AtomicInteger lineNumber)
boolean	pathExists(String path)	check if a value-path exists
ZConfig	putValue(String path, String value)
void	putValues(ZConfig src)
void	save(Writer writer)
File	save(String filename)	Saves the configuration to a file.
private void	visit(ZConfig startNode, ZConfig.IVisitor handler, int level)

Methods inherited from class Object

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

Field Details

LEFT

private static final String LEFT

See Also:

• Constant Field Values

PTRN_CONTAINER

private static final Pattern PTRN_CONTAINER

PTRN_KEYVALUE

private static final Pattern PTRN_KEYVALUE

name

private final String name

children

private final Map<String,ZConfig> children

comments

private final List<String> comments

value

private String value

Constructor Details

ZConfig

public ZConfig(String name,
 ZConfig parent)

Method Details

getChild

public ZConfig getChild(String name)

getValues

public Map<String,String> getValues()

fillValues

private void fillValues(String prefix,
 Map<String,String> values)

getName

public String getName()

getValue

public String getValue(String path)

getValue

public String getValue(String path,
 String defaultValue)

pathExists

public boolean pathExists(String path)

check if a value-path exists

Parameters:

path -

Returns:

true if value-path exists

addComment

public void addComment(String comment)

add comment

Parameters:

comment -

putValue

public ZConfig putValue(String path,
 String value)

Parameters:

path -

value - set value of config item

putValues

public void putValues(ZConfig src)

visit

private void visit(ZConfig startNode,
 ZConfig.IVisitor handler,
 int level)
            throws IOException

Throws:

IOException

save

public File save(String filename)
          throws IOException

Saves the configuration to a file.

This method will overwrite contents of existing file

Parameters:

filename - the path of the file to save the configuration into, or "-" to dump it to standard output

Returns:

the saved file or null if dumped to the standard output

Throws:

IOException - if unable to save the file.

save

public void save(Writer writer)
          throws IOException

Throws:

IOException

load

public static ZConfig load(String filename)
                    throws IOException

Throws:

IOException

load

private static ZConfig load(ZConfig parent,
 List<String> content,
 int currentLevel,
 AtomicInteger lineNumber)

child

private static ZConfig child(ZConfig parent,
 Matcher matcher,
 int currentLevel,
 String currentLine,
 AtomicInteger lineNumber)