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.examples.newvalidation;
33
34 import nl.chess.it.util.config.Config;
35 import nl.chess.it.util.config.InvalidPropertyException;
36
37
38 /***
39 * This class shows how to provide project-specific validation on properties. It has a single method, that returns an <i>int</i>
40 * that is always even. This means that the caller can always be sure that the <i>int</i> returned is an even number.
41 *
42 * <p>
43 * It is possible to extend this behavior, to return real project specific objects. This is a matter of personal taste. Next to
44 * that, if a real project object is returned, it often requires a database to exist and functioning. Obviously this doesn't work
45 * when the configuration details are not known yet.
46 * </p>
47 *
48 * @author Guus Bosman (Chess iT)
49 * @version $Revision: 1.1.1.1 $
50 */
51 public class CustomValidationConfig extends Config {
52 /***
53 * Name of the file we are looking for to read the configuration.
54 */
55 public static final String RESOURCE_NAME = "customvalidation.properties";
56
57 public CustomValidationConfig(String resourceName) {
58 super(resourceName);
59 }
60
61 /***
62 * Return the amount of legs that has been defined in the properties.
63 *
64 * @return Even number of legs.
65 */
66 public int getAmountOfLegs() {
67 int value = getInt("amount.of.legs");
68
69 if ((value % 2) != 0) {
70 throw new InvalidPropertyException("amount.of.legs", "" + value, "even number");
71 }
72
73 return value;
74 }
75 }