1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.util.url;
35
36
37 /**
38 * This class provides utility methods to manipulate an url parameter
39 */
40 public class UrlParameterItem
41 {
42 ////////////////////////////////////////////////////////////////////////////
43 // Attributes
44
45 /** the name of the parameter. */
46 private String _strName;
47
48 /** the value of the parameter. */
49 private String _strValue;
50
51 ////////////////////////////////////////////////////////////////////////////
52 // Constructors
53
54 /**
55 * Constructs a UrlParameterItem.
56 * @param strName The name of the parameter.
57 * @param strValue The value of the parameter.
58 */
59 public UrlParameterItem( String strName, String strValue )
60 {
61 _strName = strName;
62 _strValue = strValue;
63 }
64
65 /**
66 * Constructs a UrlParameterItem.
67 * @param strName The name of the parameter.
68 * @param nValue The value of the parameter.
69 */
70 public UrlParameterItem( String strName, int nValue )
71 {
72 _strName = strName;
73 _strValue = Integer.toString( nValue );
74 }
75
76 ////////////////////////////////////////////////////////////////////////////
77 // public method
78
79 /**
80 * Return the string to insert the parameter in the url.
81 *
82 * @param bFirst True if this is the first url parameter.
83 * @return String The string to insert in the url.
84 */
85 public String getCode( boolean bFirst )
86 {
87 return ( ( bFirst ) ? "?" : "&" ) + _strName + "=" + _strValue;
88 }
89
90 /**
91 * Return the string to insert the parameter in the url.
92 *
93 * @param bFirst True if this is the first url parameter.
94 * @return String The string to insert in the url.
95 */
96 public String getCodeEntity( boolean bFirst )
97 {
98 return ( ( bFirst ) ? "?" : "&" ) + _strName + "=" + _strValue;
99 }
100 }