Package uk.ac.starlink.util
Class CgiQuery
- java.lang.Object
-
- uk.ac.starlink.util.CgiQuery
-
public class CgiQuery extends java.lang.Object
Utility class for constructing CGI query strings.- Since:
- 1 Oct 2004
- Author:
- Mark Taylor (Starlink)
-
-
Constructor Summary
Constructors Constructor Description CgiQuery(java.lang.String base)
Constructs a CGI query.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CgiQuery
addArgument(java.lang.String name, double value)
Adds a floating point argument to this query.CgiQuery
addArgument(java.lang.String name, float value)
Adds a single-precision floating point argument to this query.CgiQuery
addArgument(java.lang.String name, long value)
Adds an integer argument to this query.CgiQuery
addArgument(java.lang.String name, java.lang.String value)
Adds a string argument to this query.boolean
equals(java.lang.Object o)
static java.lang.String
formatDouble(double value)
Formats a double precision value.static java.lang.String
formatDouble(double value, int nsf, int maxleng)
Formats a floating point value.static java.lang.String
formatFloat(float value)
Formats a single precision value.int
hashCode()
java.lang.String
toString()
Returns this query as a string.java.net.URL
toURL()
Returns this query as a URL.
-
-
-
Constructor Detail
-
CgiQuery
public CgiQuery(java.lang.String base)
Constructs a CGI query. The submittedbase
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:
java.lang.IllegalArgumentException
- if base is not a legal base URL
-
-
Method Detail
-
addArgument
public CgiQuery addArgument(java.lang.String name, long value)
Adds an integer argument to this query. For convenience the return value is this query.- Parameters:
name
- argument namevalue
- value for the argument- Returns:
- this query
-
addArgument
public CgiQuery addArgument(java.lang.String name, double value)
Adds a floating point argument to this query. For convenience the return value is this query.- Parameters:
name
- argument namevalue
- value for the argument- Returns:
- this query
-
addArgument
public CgiQuery addArgument(java.lang.String name, float value)
Adds a single-precision floating point argument to this query. For convenience the return value is this query.- Parameters:
name
- argument namevalue
- value for the argument- Returns:
- this query
-
addArgument
public CgiQuery addArgument(java.lang.String name, java.lang.String value)
Adds a string argument to this query. For convenience the return value is this query.- Parameters:
name
- argument namevalue
- unescaped value for the argument- Returns:
- this query
-
toURL
public java.net.URL toURL()
Returns this query as a URL.- Returns:
- query URL
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
Returns this query as a string.- Overrides:
toString
in classjava.lang.Object
- Returns:
- query string
-
formatDouble
public static java.lang.String formatDouble(double value)
Formats a double precision value.- Parameters:
value
- value- Returns:
- string representation
-
formatFloat
public static java.lang.String formatFloat(float value)
Formats a single precision value.- Parameters:
value
- value- Returns:
- string representation
-
formatDouble
public static java.lang.String formatDouble(double value, int nsf, int maxleng)
Formats a floating point value. It will be done in fixed point format if it can be done within the given number of characters, else exponential notation.- Parameters:
value
- valuensf
- number of significant figuresmaxleng
- maximum length of string - if longer than this, will return to exponential notation- Returns:
- fixed format string representation
-
-