View Javadoc

1   /***
2    * Copyright (c) 2003, 2004, Chess iT
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without modification,
6    * are permitted provided that the following conditions are met:
7    * 
8    * - Redistributions of source code must retain the above copyright notice, this
9    *   list of conditions and the following disclaimer.
10   *
11   * - Redistributions in binary form must reproduce the above copyright notice,
12   *   this list of conditions and the following disclaimer in the documentation
13   *   and/or other materials provided with the distribution.
14   *
15   * - Neither the name of Chess iT, nor the names of its contributors may be used 
16   *   to endorse or promote products derived from this software without specific
17   *   prior written permission.
18   *
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
20   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
21   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
22   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
23   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
24   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
25   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
26   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
27   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
29   * POSSIBILITY OF SUCH DAMAGE.
30   * 
31   */
32  package nl.chess.it.util.config;
33  
34  /***
35   * Thrown when a required property could not be found.
36   *
37   * @author Guus Bosman (Chess iT)
38   * @version $Revision: 1.1.1.1 $
39   */
40  public class MissingPropertyException extends ConfigurationException {
41      /***
42       * Describes what type of variable we thought the property should be.
43       */
44      private final String expectedtype;
45      private final String propertyname;
46  
47  
48      public MissingPropertyException(String propertyname) {
49          this.propertyname = propertyname;
50          this.expectedtype = null;
51      }
52  
53      public MissingPropertyException(String propertyname, String expectedtype) {
54          this.propertyname = propertyname;
55          this.expectedtype = expectedtype;
56      }
57  
58      /***
59       * Returns the name of the property that was missing.
60       *
61       * @return
62       */
63      public String getPropertyname() {
64          return propertyname;
65      }
66  
67  	/***
68  	 * Returns the expected type of the property that was missing
69  	 *
70  	 * @return String description of the type, or <code>null</code> if this is unknown.
71  	 */
72  	public String getExpectedType() {
73  		return expectedtype;
74  	}
75      public String toString() {
76          return this.getClass().getName() + ": '" + propertyname + "'";
77      }
78  }