src/net/fortuna/ical4j/util/ParameterValidator.java

changeset 0
fb9019fb1bf7
equal deleted inserted replaced
-1:000000000000 0:93f66a8876e5
1 /**
2 * Copyright (c) 2012, Ben Fortuna
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 * o Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * o Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * o Neither the name of Ben Fortuna nor the names of any other contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 package net.fortuna.ical4j.util;
33
34 import net.fortuna.ical4j.model.Parameter;
35 import net.fortuna.ical4j.model.ParameterList;
36 import net.fortuna.ical4j.model.ValidationException;
37
38 /**
39 * $Id$ [15-May-2004]
40 *
41 * Defines methods for validating parameters and parameter
42 * lists.
43 *
44 * @author Ben Fortuna
45 */
46 public final class ParameterValidator {
47
48 private static final String ASSERT_NONE_MESSAGE = "Parameter [{0}] is not applicable";
49
50 private static final String ASSERT_ONE_OR_LESS_MESSAGE = "Parameter [{0}] must only be specified once";
51
52 private static final String ASSERT_ONE_MESSAGE = "Parameter [{0}] must be specified once";
53
54 private static final String ASSERT_NULL_OR_EQUAL_MESSAGE = "Parameter [{0}] is invalid";
55
56 private static ParameterValidator instance = new ParameterValidator();
57
58 /**
59 * Constructor made private to enforce singleton.
60 */
61 private ParameterValidator() {
62 }
63
64 /**
65 * Ensure a parameter occurs no more than once.
66 *
67 * @param paramName
68 * the parameter name
69 * @param parameters
70 * a list of parameters to query
71 * @throws ValidationException
72 * when the specified parameter occurs more than once
73 */
74 public void assertOneOrLess(final String paramName,
75 final ParameterList parameters) throws ValidationException {
76
77 if (parameters.getParameters(paramName).size() > 1) {
78 throw new ValidationException(ASSERT_ONE_OR_LESS_MESSAGE, new Object[] {paramName});
79 }
80 }
81
82 /**
83 * Ensure a parameter occurs once.
84 *
85 * @param paramName
86 * the parameter name
87 * @param parameters
88 * a list of parameters to query
89 * @throws ValidationException
90 * when the specified parameter does not occur once
91 */
92 public void assertOne(final String paramName,
93 final ParameterList parameters) throws ValidationException {
94
95 if (parameters.getParameters(paramName).size() != 1) {
96 throw new ValidationException(ASSERT_ONE_MESSAGE, new Object[] {paramName});
97 }
98 }
99
100 /**
101 * Ensure a parameter doesn't occur in the specified list.
102 * @param paramName the name of a parameter
103 * @param parameters a list of parameters
104 * @throws ValidationException thrown when the specified property
105 * is found in the list of properties
106 */
107 public void assertNone(final String paramName, final ParameterList parameters) throws ValidationException {
108 if (parameters.getParameter(paramName) != null) {
109 throw new ValidationException(ASSERT_NONE_MESSAGE, new Object[] {paramName});
110 }
111 }
112
113 /**
114 * @param param a parameter instance
115 * @param parameters a list of parameters
116 * @throws ValidationException where the assertion fails
117 */
118 public void assertNullOrEqual(final Parameter param, final ParameterList parameters) throws ValidationException {
119 final Parameter p = parameters.getParameter(param.getName());
120 if (p != null && !param.equals(p)) {
121 throw new ValidationException(ASSERT_NULL_OR_EQUAL_MESSAGE, new Object[] {p});
122 }
123 }
124
125 /**
126 * @return Returns the instance.
127 */
128 public static ParameterValidator getInstance() {
129 return instance;
130 }
131 }

mercurial