View Javadoc

1   /*
2   Copyright (C) 2000 - 2007 Grid Systems, S.A.
3   
4   This program is free software; you can redistribute it and/or modify
5   it under the terms of the GNU General Public License, version 2, as
6   published by the Free Software Foundation.
7   
8   This program is distributed in the hope that it will be useful,
9   but WITHOUT ANY WARRANTY; without even the implied warranty of
10  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  GNU General Public License for more details.
12  
13  You should have received a copy of the GNU General Public License
14  along with this program; if not, write to the Free Software
15  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  */
17  
18  /*
19   * Project: IGUtils
20   * Created on 29-abr-2004
21   *
22   * Copyright (c)2004 Grid Systems
23   */
24  package com.gridsystems.exceptions;
25  
26  
27  import com.gridsystems.innergrid.kernel.IKernelException;
28  
29  /**
30   * Invalid value exception.
31   *
32   * @author <a href="mailto:rruiz@gridsystems.com">Rodrigo Ruiz Aguayo</a>
33   * @version 1.0
34   */
35  public class IllegalValueException extends IKernelException  {
36  
37    /**
38     * The value name.
39     */
40    private String name = null;
41  
42    /**
43     * Constructor.
44     *
45     * @param name a String with the name of the value that is invalid.
46     * @param params a String[] with the list of params to use to parse the
47     *               error message.
48     */
49    public IllegalValueException(String name, String[] params) {
50      super("IVL000", params);
51      this.name = name;
52    }
53  
54    /**
55     * Constructor.
56     *
57     * @param code a String with the code to assign to the Exception.
58     * @param name a String with the name of the value that is invalid.
59     * @param params a String[] with the list of params to use to parse the
60     *               error message.
61     */
62    public IllegalValueException(String code, String name, String[] params) {
63      super(code, params);
64      this.name = name;
65    }
66  
67    /**
68     * Gets the name of the value that is invalid.
69     *
70     * @return a String with the name of the value that is invalid. It can be null.
71     */
72    public String getName() {
73      return this.name;
74    }
75  }