gov.nist.core

Class NameValue

java.lang.Object

gov.nist.core.GenericObject

gov.nist.core.NameValue

All Implemented Interfaces:

Serializable, Cloneable, Map.Entry<String,String>

public class NameValue
extends GenericObject
implements Map.Entry<String,String>

Generic structure for storing name-value pairs.

Version:

1.2

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isFlagParameter
protected boolean	isQuotedString

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Constructor Summary

Constructors

Constructor and Description
NameValue()
NameValue(String n, Object v) Original constructor, sets isFlagParameter to 'false'
NameValue(String n, Object v, boolean isFlag) New constructor, taking a boolean which is set if the NV pair is a flag

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clones this object.
String	encode() Get the encoded representation of this namevalue object.
StringBuilder	encode(StringBuilder buffer) Put the encoded version of this object in the given StringBuilder.
boolean	equals(Object other) Equality comparison predicate.
String	getKey()
String	getName()
String	getValue()
Object	getValueAsObject()
Object	getValueAsObject(boolean stripQuotes)
int	hashCode()
boolean	isValueQuoted() Return true if the value is quoted in doublequotes.
void	setName(String n) Set the name member
void	setQuotedValue() A flag that indicates that doublequotes should be put around the value when encoded (for example name=value when value is doublequoted).
void	setSeparator(String sep) Set the separator for the encoding method below.
String	setValue(String value)
void	setValueAsObject(Object v) Set the value member

Methods inherited from class gov.nist.core.GenericObject

dbgPrint, dbgPrint, debugDump, debugDump, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, match, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

isQuotedString

protected boolean isQuotedString

isFlagParameter

protected final boolean isFlagParameter

Constructor Detail

NameValue

public NameValue()

NameValue

public NameValue(String n,
         Object v,
         boolean isFlag)

New constructor, taking a boolean which is set if the NV pair is a flag

Parameters:

n -

v -

isFlag -

NameValue

public NameValue(String n,
         Object v)

Original constructor, sets isFlagParameter to 'false'

Parameters:

n -

v -

Method Detail

setSeparator

public void setSeparator(String sep)

Set the separator for the encoding method below.

setQuotedValue

public void setQuotedValue()

A flag that indicates that doublequotes should be put around the value when encoded (for example name=value when value is doublequoted).

isValueQuoted

public boolean isValueQuoted()

Return true if the value is quoted in doublequotes.

getName

public String getName()

getValueAsObject

public Object getValueAsObject()

getValueAsObject

public Object getValueAsObject(boolean stripQuotes)

setName

public void setName(String n)

Set the name member

setValueAsObject

public void setValueAsObject(Object v)

Set the value member

encode

public String encode()

Get the encoded representation of this namevalue object. Added doublequote for encoding doublequoted values. Bug: RFC3261 stipulates that an opaque parameter in authenticate header has to be: opaque = "opaque" EQUAL quoted-string so returning just the name is not acceptable. (e.g. LinkSys phones are picky about this)

Specified by:

encode in class GenericObject

Returns:

an encoded name value (eg. name=value) string.

Since:

1.0

encode

public StringBuilder encode(StringBuilder buffer)

Description copied from class: GenericObject

Put the encoded version of this object in the given StringBuilder.

Overrides:

encode in class GenericObject

clone

public Object clone()

Description copied from class: GenericObject

Clones this object.

Overrides:

clone in class GenericObject

equals

public boolean equals(Object other)

Equality comparison predicate.

Specified by:

equals in interface Map.Entry<String,String>

Overrides:

equals in class GenericObject

Parameters:

other - is the other object to test against.

Returns:

true if the objects are euqal and false otherwise

getKey

public String getKey()

Specified by:

getKey in interface Map.Entry<String,String>

getValue

public String getValue()

Specified by:

getValue in interface Map.Entry<String,String>

setValue

public String setValue(String value)

Specified by:

setValue in interface Map.Entry<String,String>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map.Entry<String,String>

Overrides:

hashCode in class Object