|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.webchat.util.ParamUtils
public class ParamUtils
A utility class to handle servlet parameters.
Constructor Summary | |
---|---|
ParamUtils()
|
Method Summary | |
---|---|
static java.lang.String |
getAttribute(javax.servlet.http.HttpServletRequest request,
java.lang.String name)
Gets a parameter as a string. |
static java.lang.String |
getAttribute(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
boolean emptyStringsOK)
Gets a parameter as a string. |
static boolean |
getBooleanAttribute(javax.servlet.http.HttpServletRequest request,
java.lang.String name)
Gets an attribute as a boolean. |
static boolean |
getBooleanParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name)
Gets a parameter as a boolean. |
static boolean |
getBooleanParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
boolean defaultVal)
Gets a parameter as a boolean. |
static double |
getDoubleParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
double defaultNum)
Gets a parameter as a double. |
static int |
getIntAttribute(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
int defaultNum)
Gets an attribute as a int. |
static int |
getIntParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
int defaultNum)
Gets a parameter as an int. |
static int[] |
getIntParameters(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
int defaultNum)
Gets a list of int parameters. |
static long |
getLongAttribute(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
long defaultNum)
Gets an attribute as a long. |
static long |
getLongParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
long defaultNum)
Gets a parameter as a long. |
static long[] |
getLongParameters(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
long defaultNum)
Gets a list of long parameters. |
static java.lang.String |
getParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name)
Returns a parameter as a string or null if the parameter doesn't exist or is an empty string. |
static java.lang.String |
getParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
boolean emptyStringsOK)
Returns a paramter as a string or null if the parameter doesn't exist. |
static java.lang.String |
getParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
java.lang.String defaultValue)
Returns a paramter as a string or the default value if the paramter doesn't exist or is an empty string. |
static java.lang.String |
getParameter(javax.servlet.http.HttpServletRequest request,
java.lang.String name,
java.lang.String defaultValue,
boolean emptyStringsOK)
Returns a paramter as a string or the specified default value if the parameter doesn't exist. |
static java.lang.String[] |
getParameters(javax.servlet.http.HttpServletRequest request,
java.lang.String name)
Returns a list of parameters of the same name |
static java.lang.String |
getPathToPage(javax.servlet.http.HttpServletRequest request)
Returns the path to the requested page. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ParamUtils()
Method Detail |
---|
public static java.lang.String getParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name)
request
- the HTTP request.name
- the name of the paramter.
public static java.lang.String getParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String defaultValue)
request
- the HTTP request.name
- the name of the parameter.defaultValue
- the value to return if the paramter was not found or was an empty string.
public static java.lang.String getParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, boolean emptyStringsOK)
request
- the HTTP request.name
- the name of the parameter.emptyStringsOK
- true if parameters with the value "" are acceptable, false if not.
public static java.lang.String getParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String defaultValue, boolean emptyStringsOK)
request
- the HTTP request.name
- the name of the parameter.defaultValue
- the default value of the parameter if it was not found and if the value is "" and
the emptyStringsOK paramter is false.emptyStringsOK
- true if parameters with the value "" are acceptable, false if not.
public static java.lang.String[] getParameters(javax.servlet.http.HttpServletRequest request, java.lang.String name)
request
- an HttpServletRequest object.
public static boolean getBooleanParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to get
public static boolean getBooleanParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, boolean defaultVal)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to get
public static int getIntParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, int defaultNum)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to get
public static int[] getIntParameters(javax.servlet.http.HttpServletRequest request, java.lang.String name, int defaultNum)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to getdefaultNum
- The default value of a parameter, if the parameter
can't be converted into an int.public static double getDoubleParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, double defaultNum)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to get
public static long getLongParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, long defaultNum)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to get
public static long[] getLongParameters(javax.servlet.http.HttpServletRequest request, java.lang.String name, long defaultNum)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to getdefaultNum
- The default value of a parameter, if the parameter
can't be converted into a long.public static java.lang.String getAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to get
public static java.lang.String getAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name, boolean emptyStringsOK)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the parameter you want to getemptyStringsOK
- Return the parameter values even if it is an empty string.
public static boolean getBooleanAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the attribute you want to get
public static int getIntAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name, int defaultNum)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the attribute you want to get
public static long getLongAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name, long defaultNum)
request
- The HttpServletRequest object, known as "request" in a
JSP page.name
- The name of the attribute you want to get
public static java.lang.String getPathToPage(javax.servlet.http.HttpServletRequest request)
request
- The HttpServletRequest
instance, known as "request" in a JSP page.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |