org.restlet.data

Class Parameter

java.lang.Object

org.restlet.data.Parameter

All Implemented Interfaces:

java.lang.Comparable<Parameter>, NamedValue<java.lang.String>

public class Parameter
extends java.lang.Object
implements java.lang.Comparable<Parameter>, NamedValue<java.lang.String>

Multi-usage parameter. Note that the name and value properties are thread safe, stored in volatile members.

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
Parameter() Default constructor.
Parameter(java.lang.String name, java.lang.String value) Preferred constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Parameter o)
static Parameter	create(java.lang.CharSequence name, java.lang.CharSequence value) Creates a parameter.
void	encode(java.lang.Appendable buffer, CharacterSet characterSet) Encodes the parameter into the target buffer.
java.lang.String	encode(CharacterSet characterSet) Encodes the parameter as a string.
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name of this parameter.
java.lang.String	getValue() Returns the value.
int	hashCode()
void	setName(java.lang.String name)
void	setValue(java.lang.String value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Parameter

public Parameter()

Default constructor.

Parameter

public Parameter(java.lang.String name,
                 java.lang.String value)

Preferred constructor.

Parameters:

name - The name.

value - The value.

Method Detail

create

public static Parameter create(java.lang.CharSequence name,
                               java.lang.CharSequence value)

Creates a parameter.

Parameters:

name - The parameter name buffer.

value - The parameter value buffer (can be null).

Returns:

The created parameter.

Throws:

java.io.IOException

compareTo

public int compareTo(Parameter o)

Specified by:

compareTo in interface java.lang.Comparable<Parameter>

encode

public void encode(java.lang.Appendable buffer,
                   CharacterSet characterSet)
            throws java.io.IOException

Encodes the parameter into the target buffer.

Parameters:

buffer - The target buffer.

characterSet - The character set to use.

Throws:

java.io.IOException

encode

public java.lang.String encode(CharacterSet characterSet)
                        throws java.io.IOException

Encodes the parameter as a string.

Parameters:

characterSet - The character set to use.

Returns:

The encoded string?

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Description copied from interface: NamedValue

Returns the name of this parameter.

Specified by:

getName in interface NamedValue<java.lang.String>

Returns:

The name of this parameter.

getValue

public java.lang.String getValue()

Description copied from interface: NamedValue

Returns the value.

Specified by:

getValue in interface NamedValue<java.lang.String>

Returns:

The value.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setName

public void setName(java.lang.String name)

setValue

public void setValue(java.lang.String value)

Description copied from interface: NamedValue

Sets the value.

Specified by:

setValue in interface NamedValue<java.lang.String>

Parameters:

value - The value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object