View Javadoc

1   /*
2    * $Id: InvalidParameterException.java 129 2004-11-27 22:14:22Z josem $
3    *
4    * Tarsis
5    * Copyright (C) 2002 Talika Open Source Group
6    *
7    * This program is free software; you can redistribute it and/or modify
8    * it under the terms of the GNU General Public License as published by
9    * the Free Software Foundation; either version 2 of the License, or
10   * (at your option) any later version.
11   *
12   * This program is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   * GNU General Public License for more details.
16   *
17   * You should have received a copy of the GNU General Public License
18   * along with this program; if not, write to the Free Software
19   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20   *
21   */
22  
23  package org.talika.tarsis.filters.validator;
24  
25  import org.talika.tarsis.error.UserException;
26  
27  /**
28   * Thrown by <code>ValidatorFilter</code> to indicate an invalid parameter value.
29   *
30   * @author  Jose M. Palomar
31   * @version $Revision: 129 $
32   */
33  public class InvalidParameterException extends UserException {
34  
35      // Fields
36      /**
37       * Parameter name.
38       */
39      private String paramName;
40  
41      /**
42       * Parameter value.
43       */
44      private String paramValue;
45  
46      // Constructors
47      /**
48       * Constructs a new <code>InvalidParameterException</code> with given message.
49       *
50       * @param msg String text of the exception message.
51       */
52      public InvalidParameterException(String msg) {
53          super(msg);
54      }
55  
56      /**
57       * Constructs a new <code>InvalidParameterException</code> with given parameter
58       * name and value.
59       *
60       * @param paramName String parameter name.
61       * @param paramValue String parameter value.
62       */
63      public InvalidParameterException(String paramName, String paramValue) {
64          this(null, paramName, paramValue);
65      }
66  
67      /**
68       * Constructs a new <code>InvalidParameterException</code> with given parameter
69       * name and value and message.
70       *
71       * @param msg String text of the exception message.
72       * @param paramName String parameter name.
73       * @param paramValue String parameter value.
74       */
75      public InvalidParameterException(String msg, String paramName, String paramValue) {
76          super(msg);
77          this.paramName = paramName;
78          this.paramValue = paramValue;
79      }
80  
81      // Method
82      /**
83       * Returns parameter name.
84       *
85       * @return String parameter name.
86       */
87      public String getParameterName() {
88          return paramName;
89      }
90  
91      /**
92       * Returns parameter value.
93       *
94       * @return String parameter value.
95       */
96      public String getParameterValue() {
97          return paramValue;
98      }
99  
100 }