1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.util;
24  
25  import java.text.DateFormat;
26  
27  import java.util.Date;
28  import java.util.Enumeration;
29  
30  import javax.portlet.PortletRequest;
31  
32  import javax.servlet.http.HttpServletRequest;
33  
34  /**
35   * <a href="ParamUtil.java.html"><b><i>View Source</i></b></a>
36   *
37   * @author Brian Wing Shun Chan
38   * @author Raymond Augé
39   */
40  public class ParamUtil {
41  
42      public static boolean get(
43          HttpServletRequest request, String param, boolean defaultValue) {
44  
45          return GetterUtil.get(request.getParameter(param), defaultValue);
46      }
47  
48      public static Date get(
49          HttpServletRequest request, String param, DateFormat df,
50          Date defaultValue) {
51  
52          return GetterUtil.get(request.getParameter(param), df, defaultValue);
53      }
54  
55      public static double get(
56          HttpServletRequest request, String param, double defaultValue) {
57  
58          return GetterUtil.get(request.getParameter(param), defaultValue);
59      }
60  
61      public static float get(
62          HttpServletRequest request, String param, float defaultValue) {
63  
64          return GetterUtil.get(request.getParameter(param), defaultValue);
65      }
66  
67      public static int get(
68          HttpServletRequest request, String param, int defaultValue) {
69  
70          return GetterUtil.get(request.getParameter(param), defaultValue);
71      }
72  
73      public static long get(
74          HttpServletRequest request, String param, long defaultValue) {
75  
76          return GetterUtil.get(request.getParameter(param), defaultValue);
77      }
78  
79      public static short get(
80          HttpServletRequest request, String param, short defaultValue) {
81  
82          return GetterUtil.get(request.getParameter(param), defaultValue);
83      }
84  
85      public static String get(
86          HttpServletRequest request, String param, String defaultValue) {
87  
88          String returnValue =
89              GetterUtil.get(request.getParameter(param), defaultValue);
90  
91          if (returnValue != null) {
92              return returnValue.trim();
93          }
94  
95          return null;
96      }
97  
98      public static boolean get(
99          PortletRequest portletRequest, String param, boolean defaultValue) {
100 
101         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
102     }
103 
104     public static Date get(
105         PortletRequest portletRequest, String param, DateFormat df,
106         Date defaultValue) {
107 
108         return GetterUtil.get(
109             portletRequest.getParameter(param), df, defaultValue);
110     }
111 
112     public static double get(
113         PortletRequest portletRequest, String param, double defaultValue) {
114 
115         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
116     }
117 
118     public static float get(
119         PortletRequest portletRequest, String param, float defaultValue) {
120 
121         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
122     }
123 
124     public static int get(
125         PortletRequest portletRequest, String param, int defaultValue) {
126 
127         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
128     }
129 
130     public static long get(
131         PortletRequest portletRequest, String param, long defaultValue) {
132 
133         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
134     }
135 
136     public static short get(
137         PortletRequest portletRequest, String param, short defaultValue) {
138 
139         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
140     }
141 
142     public static String get(
143         PortletRequest portletRequest, String param, String defaultValue) {
144 
145         String returnValue =
146             GetterUtil.get(portletRequest.getParameter(param), defaultValue);
147 
148         if (returnValue != null) {
149             return returnValue.trim();
150         }
151 
152         return null;
153     }
154 
155     public static boolean getBoolean(HttpServletRequest request, String param) {
156         return GetterUtil.getBoolean(request.getParameter(param));
157     }
158 
159     public static boolean getBoolean(
160         HttpServletRequest request, String param, boolean defaultValue) {
161 
162         return get(request, param, defaultValue);
163     }
164 
165     public static boolean getBoolean(
166         PortletRequest portletRequest, String param) {
167 
168         return GetterUtil.getBoolean(portletRequest.getParameter(param));
169     }
170 
171     public static boolean getBoolean(
172         PortletRequest portletRequest, String param, boolean defaultValue) {
173 
174         return get(portletRequest, param, defaultValue);
175     }
176 
177     public static boolean[] getBooleanValues(
178         HttpServletRequest request, String param) {
179 
180         return getBooleanValues(request, param, new boolean[0]);
181     }
182 
183     public static boolean[] getBooleanValues(
184         HttpServletRequest request, String param, boolean[] defaultValue) {
185 
186         return GetterUtil.getBooleanValues(
187             request.getParameterValues(param), defaultValue);
188     }
189 
190     public static boolean[] getBooleanValues(
191         PortletRequest portletRequest, String param) {
192 
193         return getBooleanValues(portletRequest, param, new boolean[0]);
194     }
195 
196     public static boolean[] getBooleanValues(
197         PortletRequest portletRequest, String param, boolean[] defaultValue) {
198 
199         return GetterUtil.getBooleanValues(
200             portletRequest.getParameterValues(param), defaultValue);
201     }
202 
203     public static Date getDate(
204         HttpServletRequest request, String param, DateFormat df) {
205 
206         return GetterUtil.getDate(request.getParameter(param), df);
207     }
208 
209     public static Date getDate(
210         HttpServletRequest request, String param, DateFormat df,
211         Date defaultValue) {
212 
213         return get(request, param, df, defaultValue);
214     }
215 
216     public static Date getDate(
217         PortletRequest portletRequest, String param, DateFormat df) {
218 
219         return GetterUtil.getDate(portletRequest.getParameter(param), df);
220     }
221 
222     public static Date getDate(
223         PortletRequest portletRequest, String param, DateFormat df,
224         Date defaultValue) {
225 
226         return get(portletRequest, param, df, defaultValue);
227     }
228 
229     public static double getDouble(HttpServletRequest request, String param) {
230         return GetterUtil.getDouble(request.getParameter(param));
231     }
232 
233     public static double getDouble(
234         HttpServletRequest request, String param, double defaultValue) {
235 
236         return get(request, param, defaultValue);
237     }
238 
239     public static double getDouble(
240         PortletRequest portletRequest, String param) {
241 
242         return GetterUtil.getDouble(portletRequest.getParameter(param));
243     }
244 
245     public static double getDouble(
246         PortletRequest portletRequest, String param, double defaultValue) {
247 
248         return get(portletRequest, param, defaultValue);
249     }
250 
251     public static double[] getDoubleValues(
252         HttpServletRequest request, String param) {
253 
254         return getDoubleValues(request, param, new double[0]);
255     }
256 
257     public static double[] getDoubleValues(
258         HttpServletRequest request, String param, double[] defaultValue) {
259 
260         return GetterUtil.getDoubleValues(
261             request.getParameterValues(param), defaultValue);
262     }
263 
264     public static double[] getDoubleValues(
265         PortletRequest portletRequest, String param) {
266 
267         return getDoubleValues(portletRequest, param, new double[0]);
268     }
269 
270     public static double[] getDoubleValues(
271         PortletRequest portletRequest, String param, double[] defaultValue) {
272 
273         return GetterUtil.getDoubleValues(
274             portletRequest.getParameterValues(param), defaultValue);
275     }
276 
277     public static float getFloat(HttpServletRequest request, String param) {
278         return GetterUtil.getFloat(request.getParameter(param));
279     }
280 
281     public static float getFloat(
282         HttpServletRequest request, String param, float defaultValue) {
283 
284         return get(request, param, defaultValue);
285     }
286 
287     public static float getFloat(PortletRequest portletRequest, String param) {
288         return GetterUtil.getFloat(portletRequest.getParameter(param));
289     }
290 
291     public static float getFloat(
292         PortletRequest portletRequest, String param, float defaultValue) {
293 
294         return get(portletRequest, param, defaultValue);
295     }
296 
297     public static float[] getFloatValues(
298         HttpServletRequest request, String param) {
299 
300         return getFloatValues(request, param, new float[0]);
301     }
302 
303     public static float[] getFloatValues(
304         HttpServletRequest request, String param, float[] defaultValue) {
305 
306         return GetterUtil.getFloatValues(
307             request.getParameterValues(param), defaultValue);
308     }
309 
310     public static float[] getFloatValues(
311         PortletRequest portletRequest, String param) {
312 
313         return getFloatValues(portletRequest, param, new float[0]);
314     }
315 
316     public static float[] getFloatValues(
317         PortletRequest portletRequest, String param, float[] defaultValue) {
318 
319         return GetterUtil.getFloatValues(
320             portletRequest.getParameterValues(param), defaultValue);
321     }
322 
323     public static int getInteger(HttpServletRequest request, String param) {
324         return GetterUtil.getInteger(request.getParameter(param));
325     }
326 
327     public static int getInteger(
328         HttpServletRequest request, String param, int defaultValue) {
329 
330         return get(request, param, defaultValue);
331     }
332 
333     public static int getInteger(PortletRequest portletRequest, String param) {
334         return GetterUtil.getInteger(portletRequest.getParameter(param));
335     }
336 
337     public static int getInteger(
338         PortletRequest portletRequest, String param, int defaultValue) {
339 
340         return get(portletRequest, param, defaultValue);
341     }
342 
343     public static int[] getIntegerValues(
344         HttpServletRequest request, String param) {
345 
346         return getIntegerValues(request, param, new int[0]);
347     }
348 
349     public static int[] getIntegerValues(
350         HttpServletRequest request, String param, int[] defaultValue) {
351 
352         return GetterUtil.getIntegerValues(
353             request.getParameterValues(param), defaultValue);
354     }
355 
356     public static int[] getIntegerValues(
357         PortletRequest portletRequest, String param) {
358 
359         return getIntegerValues(portletRequest, param, new int[0]);
360     }
361 
362     public static int[] getIntegerValues(
363         PortletRequest portletRequest, String param, int[] defaultValue) {
364 
365         return GetterUtil.getIntegerValues(
366             portletRequest.getParameterValues(param), defaultValue);
367     }
368 
369     public static long getLong(HttpServletRequest request, String param) {
370         return GetterUtil.getLong(request.getParameter(param));
371     }
372 
373     public static long getLong(
374         HttpServletRequest request, String param, long defaultValue) {
375 
376         return get(request, param, defaultValue);
377     }
378 
379     public static long getLong(PortletRequest portletRequest, String param) {
380         return GetterUtil.getLong(portletRequest.getParameter(param));
381     }
382 
383     public static long getLong(
384         PortletRequest portletRequest, String param, long defaultValue) {
385 
386         return get(portletRequest, param, defaultValue);
387     }
388 
389     public static long[] getLongValues(
390         HttpServletRequest request, String param) {
391 
392         return getLongValues(request, param, new long[0]);
393     }
394 
395     public static long[] getLongValues(
396         HttpServletRequest request, String param, long[] defaultValue) {
397 
398         return GetterUtil.getLongValues(
399             request.getParameterValues(param), defaultValue);
400     }
401 
402     public static long[] getLongValues(
403         PortletRequest portletRequest, String param) {
404 
405         return getLongValues(portletRequest, param, new long[0]);
406     }
407 
408     public static long[] getLongValues(
409         PortletRequest portletRequest, String param, long[] defaultValue) {
410 
411         return GetterUtil.getLongValues(
412             portletRequest.getParameterValues(param), defaultValue);
413     }
414 
415     public static short getShort(HttpServletRequest request, String param) {
416         return GetterUtil.getShort(request.getParameter(param));
417     }
418 
419     public static short getShort(
420         HttpServletRequest request, String param, short defaultValue) {
421 
422         return get(request, param, defaultValue);
423     }
424 
425     public static short getShort(PortletRequest portletRequest, String param) {
426         return GetterUtil.getShort(portletRequest.getParameter(param));
427     }
428 
429     public static short getShort(
430         PortletRequest portletRequest, String param, short defaultValue) {
431 
432         return get(portletRequest, param, defaultValue);
433     }
434 
435     public static short[] getShortValues(
436         HttpServletRequest request, String param) {
437 
438         return getShortValues(request, param, new short[0]);
439     }
440 
441     public static short[] getShortValues(
442         HttpServletRequest request, String param, short[] defaultValue) {
443 
444         return GetterUtil.getShortValues(
445             request.getParameterValues(param), defaultValue);
446     }
447 
448     public static short[] getShortValues(
449         PortletRequest portletRequest, String param) {
450 
451         return getShortValues(portletRequest, param, new short[0]);
452     }
453 
454     public static short[] getShortValues(
455         PortletRequest portletRequest, String param, short[] defaultValue) {
456 
457         return GetterUtil.getShortValues(
458             portletRequest.getParameterValues(param), defaultValue);
459     }
460 
461     public static String getString(HttpServletRequest request, String param) {
462         return GetterUtil.getString(request.getParameter(param));
463     }
464 
465     public static String getString(
466         HttpServletRequest request, String param, String defaultValue) {
467 
468         return get(request, param, defaultValue);
469     }
470 
471     public static String getString(
472         PortletRequest portletRequest, String param) {
473 
474         return GetterUtil.getString(portletRequest.getParameter(param));
475     }
476 
477     public static String getString(
478         PortletRequest portletRequest, String param, String defaultValue) {
479 
480         return get(portletRequest, param, defaultValue);
481     }
482 
483     public static void print(HttpServletRequest request) {
484         Enumeration<String> enu = request.getParameterNames();
485 
486         while (enu.hasMoreElements()) {
487             String param = enu.nextElement();
488 
489             String[] values = request.getParameterValues(param);
490 
491             for (int i = 0; i < values.length; i++) {
492                 System.out.println(param + "[" + i + "] = " + values[i]);
493             }
494         }
495     }
496 
497     public static void print(PortletRequest portletRequest) {
498         Enumeration<String> enu = portletRequest.getParameterNames();
499 
500         while (enu.hasMoreElements()) {
501             String param = enu.nextElement();
502 
503             String[] values = portletRequest.getParameterValues(param);
504 
505             for (int i = 0; i < values.length; i++) {
506                 System.out.println(param + "[" + i + "] = " + values[i]);
507             }
508         }
509     }
510 
511 }