JPlate Key/Value Pair 0.2


Welcome to the JPlate Key/Value Pair (KVP) Project! This subproject of JPlate provides key/value pair functionality - much like java.util.Properties including a parser.  Currently this documentation is a "work in progress" and will be enhanced when time permits.

Please note:  This is an initial version and there is much missing (unit test cases, good Java documentation, etc).

Quick Start

This section illustrates how to quickly make use of the parser mentioned above.  However, remember that this is simply a "quick start" and does not explain how to use the complete KVP library.


To utilize the KVP library, include all jar files found in the release lib directory as part of the classpath.  For example, assume KVP 0.2 has been downloaded and installed to /shared/jplate-kvp-0.2 on a Linux platform:




There is a utility class that makes use of default implentations to create list/maps from files, input streams, readers and strings.  By examining the source code for this class, one can extrapolate how to extend or use the rest of the project.


Consider the following examples:

import java.util.List;

import org.jplate.kvp.KvpIfc;

import org.jplate.kvp.util.KvpUtil;


    final File kvpFile = new File ( "SomeFile.kvp" );

    final List <KvpIfc> KvpUtil.getAsList (
kvpFile );



import java.util.Map;

import org.jplate.kvp.KvpIfc;

import org.jplate.kvp.util.KvpUtil;


    final Socket kvpSocket = // Create socket in some fashion...

    final Map <String, String> KvpUtil.getAsMap (
kvpSocket.getInputStream () );


Please look to individual classes for more specific information.

Building (if desired)

If you wish to build KVP from source, you will need access to a Subversion client and Ant 1.7.0+ (preferably 1.7.1 to simplify using the included libraries - please see the documentation on Environment 1.1 for more information).

Check out the source

Create a directory for checkout, change to this directory and execute:
svn co
svn co

You will note two directories are created:  environment and kvp.

Build the source

Build the source - change directories to the aforementioned kvp directory and execute the command:


After building, you should find a kvp/assembly/release directory containing various things such as a jar file (for example KVP 0.2 release produces jplate-kvp-0.2.jar) and other files normally associated with a KVP release.


KVP has dependencies upon:

IRC Channel

There is an IRC channel on under the channel name #JPlate.  The  Project Manager is usually there most days under the name Flossy.  He is more than happy to help or answer questions you may have.

Related Links

Key/Value Pair related links follow:

Revision Information

$Date: 2007-12-26 11:09:57 -0500 (Wed, 26 Dec 2007) $
$Revision: 466 $
$Author: sfloess $
$HeadURL: $ Logo