eventweb.util

Class TvList

java.lang.Object

eventweb.util.TvList

public class TvList
extends java.lang.Object

Tag Value List and parsing methods.

This class parses and holds tag-value string pairs. It's methods are modeled after the java.util.list interface.

The string format that is parsed is of the form tag=value. This is the same as the query string portion of a URL, or the body of an HTTP POST. When multiple tag-value paires are contained in a single string the form is tag1=value1&tag2=value2
The tag and value are typically URLencoded, but unencoded strings can be handled as long as they don't contain = or & characters.

Version:

1.2.2 05/08/15

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHAR_ENCODING Claracter encoding for URLEncoder
static java.lang.String[]	DEP_LIST Class dependencies
static java.lang.String	VERSION Class version

Constructor Summary

Constructors

Constructor and Description
TvList() Create a new empty tag-value list
TvList(java.lang.String[] pair) Create a new tag-value list, with a single tag-value pair
TvList(java.lang.String tag, java.lang.String value) Create a new tag-value list, with a single tag-value pair

Method Summary

Methods

Modifier and Type	Method and Description
void	addFirst(java.lang.String[] pair) Add a tag-value pair to the beginning of the list
void	addFirst(java.lang.String tag, java.lang.String value) Add a tag and value to the beginning of the list.
boolean	addFirst(TvList newList) Add another tag-value list to the beginning of the list.
void	addLast(java.lang.String[] pair) Add a tag and value to the end of the list.
void	addLast(java.lang.String tag, java.lang.String value) Add a tag and value to the end of the list.
boolean	addLast(TvList newList) Add another tag-value list to the end of the list.
void	clear() Remove all elements from the list.
java.lang.String[]	getFirst() Get the first tag-value pair from the list.
int	indexOfTag(java.lang.String tag) Get the location of the first occurrence of a tag.
boolean	isEmpty() Determine if the list is empty.
java.util.Iterator<java.lang.String[]>	iterator() Get an iterator of the elements in the list.
static TvList	parseTagValue(java.lang.String tagValStr) Parse a tag-value string.
static TvList	parseTagValue(java.lang.String tagValStr, boolean urlDecode) Parse a tag-value string.
void	readFrom(java.io.BufferedReader source) Read a tag-value list from a BufferedReader.
java.lang.String[]	remove(int idx) Remove the tag-value pair at the specified location from the list.
java.lang.String[]	removeFirst() Remove the first tag-value pair from the list.
int	size() Get the number of tag-value pairs in the list.
java.lang.String	toString() Return the list as a String.
java.lang.String	urlEncode() Return the list as a URL Encoded String.
void	writeTo(java.io.PrintWriter dest) Write a tag-value list to a PrintWriter.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

Class version

See Also:

Constant Field Values

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies

CHAR_ENCODING

public static final java.lang.String CHAR_ENCODING

Claracter encoding for URLEncoder

See Also:

Constant Field Values

Constructor Detail

TvList

public TvList()

Create a new empty tag-value list

TvList

public TvList(java.lang.String[] pair)

Create a new tag-value list, with a single tag-value pair

Parameters:

pair - A two element string array with a tag-value pair

TvList

public TvList(java.lang.String tag,
      java.lang.String value)

Create a new tag-value list, with a single tag-value pair

Parameters:

tag - Tag for tag-value pair

value - Value for tag-value pair

Method Detail

parseTagValue

public static TvList parseTagValue(java.lang.String tagValStr)

Parse a tag-value string.
The results are not URL decoded.

Parameters:

tagValStr - The string to be decoded.

Returns:

Parsed string as tag-value list.

parseTagValue

public static TvList parseTagValue(java.lang.String tagValStr,
                   boolean urlDecode)

Parse a tag-value string.

Parameters:

tagValStr - The string to be decoded.

urlDecode - If true, the results are URL decoded.

Returns:

Parsed string as tag-value list.

addFirst

public void addFirst(java.lang.String tag,
            java.lang.String value)

Add a tag and value to the beginning of the list.

Parameters:

tag - Tag for tag-value pair

value - Value for tag-value pair

addFirst

public void addFirst(java.lang.String[] pair)

Add a tag-value pair to the beginning of the list

Parameters:

pair - A two element string array with a tag-value pair

addFirst

public boolean addFirst(TvList newList)

Add another tag-value list to the beginning of the list.

Parameters:

newList - The list to be added

Returns:

ture, If newList is added successfully

addLast

public void addLast(java.lang.String tag,
           java.lang.String value)

Add a tag and value to the end of the list.

Parameters:

tag - Tag for tag-value pair

value - Value for tag-value pair

addLast

public void addLast(java.lang.String[] pair)

Add a tag and value to the end of the list.

Parameters:

pair - A two element string array with a tag-value pair

addLast

public boolean addLast(TvList newList)

Add another tag-value list to the end of the list.

Parameters:

newList - The list to be added

Returns:

ture, If newList is added successfully

getFirst

public java.lang.String[] getFirst()

Get the first tag-value pair from the list.
The list is unchanged.

Returns:

The first pair in the list

removeFirst

public java.lang.String[] removeFirst()

Remove the first tag-value pair from the list.

Returns:

The pair removed from the list

remove

public java.lang.String[] remove(int idx)

Remove the tag-value pair at the specified location from the list.

Parameters:

idx - The location of the pair to be removed

Returns:

The pair removed from the list. (Null if idx is out of bounds.)

indexOfTag

public int indexOfTag(java.lang.String tag)

Get the location of the first occurrence of a tag.

Parameters:

tag - The tag to be located

Returns:

The index of the tag-value pair with the specified tag. (-1 if the tag is not found.)

iterator

public java.util.Iterator<java.lang.String[]> iterator()

Get an iterator of the elements in the list.

Returns:

The iterator

clear

public void clear()

Remove all elements from the list.

isEmpty

public boolean isEmpty()

Determine if the list is empty.

Returns:

true, If the list contains no elements.

size

public int size()

Get the number of tag-value pairs in the list.

Returns:

The number of elements in the list

readFrom

public void readFrom(java.io.BufferedReader source)
              throws java.io.IOException

Read a tag-value list from a BufferedReader.
The entire source is read into the list.

Parameters:

source - The source to read the list from

Throws:

java.io.IOException - If an I/O error occurs

writeTo

public void writeTo(java.io.PrintWriter dest)

Write a tag-value list to a PrintWriter.
Each tag-value pair is written to a separate line.

Parameters:

dest - The destination to write the list to

urlEncode

public java.lang.String urlEncode()

Return the list as a URL Encoded String.

Returns:

A URL Encoded string representation of the list

toString

public java.lang.String toString()

Return the list as a String.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the list