org.exoplatform.web.controller.router

Class URIWriter

java.lang.Object

org.exoplatform.web.controller.router.URIWriter

public final class URIWriter
extends Object

An uri writer.

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
URIWriter(Appendable appendable) Create a new URI writer.
URIWriter(Appendable appendable, MimeType mimeType) Create a new URI writer.

Method Summary

Modifier and Type	Method and Description
void	append(char c)
void	append(String s)
void	appendQueryParameter(String parameterName, String paramaterValue) Append a query parameter to the parameter set.
void	appendSegment(char c) Append a segment to the path.
void	appendSegment(String s) Append a segment to the path.
MimeType	getMimeType()
void	reset(Appendable appendable) Reset the writer for reuse.
void	setMimeType(MimeType mimeType)

Methods inherited from class java.lang.Object

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

Constructor Detail

URIWriter

public URIWriter(Appendable appendable,
                 MimeType mimeType)
          throws NullPointerException

Create a new URI writer.

Parameters:

appendable - the appendable

mimeType - the mime type

Throws:

NullPointerException - if the appendable argument is null

URIWriter

public URIWriter(Appendable appendable)
          throws NullPointerException

Create a new URI writer.

Parameters:

appendable - the appendable

Throws:

NullPointerException - if the appendable argument is null

Method Detail

getMimeType

public MimeType getMimeType()

setMimeType

public void setMimeType(MimeType mimeType)

append

public void append(char c)
            throws IOException

Throws:

IOException

append

public void append(String s)
            throws IOException

Throws:

IOException

appendSegment

public void appendSegment(char c)
                   throws IllegalStateException,
                          IOException

Append a segment to the path.

Parameters:

c - the char to append

Throws:

IllegalStateException - if a query parameter was already appended

IOException - any IO exception

appendSegment

public void appendSegment(String s)
                   throws NullPointerException,
                          IllegalStateException,
                          IOException

Append a segment to the path.

Parameters:

s - the string to append.

Throws:

NullPointerException - if any argument value is null

IllegalStateException - if a query parameter was already appended

IOException - any IO exception

appendQueryParameter

public void appendQueryParameter(String parameterName,
                                 String paramaterValue)
                          throws NullPointerException,
                                 IOException

Append a query parameter to the parameter set. Note that the query parameters are ordered and the sequence of call to this method should be honoured when an URL is generated. Note also that the same parameter name can be used multiple times.

Parameters:

parameterName - the parameter name

paramaterValue - the parameter value

Throws:

NullPointerException - if any argument value is null

IOException - any IOException

reset

public void reset(Appendable appendable)

Reset the writer for reuse.

Parameters:

appendable - the used appendable