uk.ac.starlink.util
Class CgiQuery

java.lang.Object
  |
  +--uk.ac.starlink.util.CgiQuery

public class CgiQuery
extends Object

Utility class for constructing CGI query strings.

Since:
1 Oct 2004

Constructor Summary
CgiQuery(String base)
          Constructs a CGI query.
 
Method Summary
 CgiQuery addArgument(String name, double value)
          Adds a floating point argument to this query.
 CgiQuery addArgument(String name, long value)
          Adds an integer argument to this query.
 CgiQuery addArgument(String name, String value)
          Adds a string argument to this query.
 boolean equals(Object o)
           
 int hashCode()
           
 String toString()
          Returns this query as a string.
 URL toURL()
          Returns this query as a URL.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CgiQuery

public CgiQuery(String base)
Constructs a CGI query. The submitted base argument may optionally be a partially-formed CGI-query, that is, one ending in a '?' and zero or more '&name=value' pairs.

Parameters:
base - base part of the CGI URL
Throws:
IllegalArgumentException - if base is not a legal base URL
Method Detail

addArgument

public CgiQuery addArgument(String name,
                            long value)
Adds an integer argument to this query. For convenience the return value is this query.

Parameters:
name - argument name
value - value for the argument
Returns:
this query

addArgument

public CgiQuery addArgument(String name,
                            double value)
Adds a floating point argument to this query. For convenience the return value is this query.

Parameters:
name - argument name
value - value for the argument
Returns:
this query

addArgument

public CgiQuery addArgument(String name,
                            String value)
Adds a string argument to this query. For convenience the return value is this query.

Parameters:
name - argument name
value - unescaped value for the argument
Returns:
this query

toURL

public URL toURL()
Returns this query as a URL.

Returns:
query URL

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Returns this query as a string.

Overrides:
toString in class Object
Returns:
query string

Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.