View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of 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   * This class provides utility methods to manipulate an url parameter
38   */
39  public class UrlParameterItem
40  {
41      // //////////////////////////////////////////////////////////////////////////
42      // Attributes
43  
44      /** the name of the parameter. */
45      private String _strName;
46  
47      /** the value of the parameter. */
48      private String _strValue;
49  
50      // //////////////////////////////////////////////////////////////////////////
51      // Constructors
52  
53      /**
54       * Constructs a UrlParameterItem.
55       * 
56       * @param strName
57       *            The name of the parameter.
58       * @param strValue
59       *            The value of the parameter.
60       */
61      public UrlParameterItem( String strName, String strValue )
62      {
63          _strName = strName;
64          _strValue = strValue;
65      }
66  
67      /**
68       * Constructs a UrlParameterItem.
69       * 
70       * @param strName
71       *            The name of the parameter.
72       * @param nValue
73       *            The value of the parameter.
74       */
75      public UrlParameterItem( String strName, int nValue )
76      {
77          _strName = strName;
78          _strValue = Integer.toString( nValue );
79      }
80  
81      // //////////////////////////////////////////////////////////////////////////
82      // public method
83  
84      /**
85       * Return the string to insert the parameter in the url.
86       *
87       * @param bFirst
88       *            True if this is the first url parameter.
89       * @return String The string to insert in the url.
90       */
91      public String getCode( boolean bFirst )
92      {
93          return ( ( bFirst ) ? "?" : "&" ) + _strName + "=" + _strValue;
94      }
95  
96      /**
97       * Return the string to insert the parameter in the url.
98       *
99       * @param bFirst
100      *            True if this is the first url parameter.
101      * @return String The string to insert in the url.
102      */
103     public String getCodeEntity( boolean bFirst )
104     {
105         return ( ( bFirst ) ? "?" : "&" ) + _strName + "=" + _strValue;
106     }
107 }