1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/util/ParameterValidator.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,131 @@
1.4 +/**
1.5 + * Copyright (c) 2012, Ben Fortuna
1.6 + * All rights reserved.
1.7 + *
1.8 + * Redistribution and use in source and binary forms, with or without
1.9 + * modification, are permitted provided that the following conditions
1.10 + * are met:
1.11 + *
1.12 + * o Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * o Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * o Neither the name of Ben Fortuna nor the names of any other contributors
1.20 + * may be used to endorse or promote products derived from this software
1.21 + * without specific prior written permission.
1.22 + *
1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.34 + */
1.35 +package net.fortuna.ical4j.util;
1.36 +
1.37 +import net.fortuna.ical4j.model.Parameter;
1.38 +import net.fortuna.ical4j.model.ParameterList;
1.39 +import net.fortuna.ical4j.model.ValidationException;
1.40 +
1.41 +/**
1.42 + * $Id$ [15-May-2004]
1.43 + *
1.44 + * Defines methods for validating parameters and parameter
1.45 + * lists.
1.46 + *
1.47 + * @author Ben Fortuna
1.48 + */
1.49 +public final class ParameterValidator {
1.50 +
1.51 + private static final String ASSERT_NONE_MESSAGE = "Parameter [{0}] is not applicable";
1.52 +
1.53 + private static final String ASSERT_ONE_OR_LESS_MESSAGE = "Parameter [{0}] must only be specified once";
1.54 +
1.55 + private static final String ASSERT_ONE_MESSAGE = "Parameter [{0}] must be specified once";
1.56 +
1.57 + private static final String ASSERT_NULL_OR_EQUAL_MESSAGE = "Parameter [{0}] is invalid";
1.58 +
1.59 + private static ParameterValidator instance = new ParameterValidator();
1.60 +
1.61 + /**
1.62 + * Constructor made private to enforce singleton.
1.63 + */
1.64 + private ParameterValidator() {
1.65 + }
1.66 +
1.67 + /**
1.68 + * Ensure a parameter occurs no more than once.
1.69 + *
1.70 + * @param paramName
1.71 + * the parameter name
1.72 + * @param parameters
1.73 + * a list of parameters to query
1.74 + * @throws ValidationException
1.75 + * when the specified parameter occurs more than once
1.76 + */
1.77 + public void assertOneOrLess(final String paramName,
1.78 + final ParameterList parameters) throws ValidationException {
1.79 +
1.80 + if (parameters.getParameters(paramName).size() > 1) {
1.81 + throw new ValidationException(ASSERT_ONE_OR_LESS_MESSAGE, new Object[] {paramName});
1.82 + }
1.83 + }
1.84 +
1.85 + /**
1.86 + * Ensure a parameter occurs once.
1.87 + *
1.88 + * @param paramName
1.89 + * the parameter name
1.90 + * @param parameters
1.91 + * a list of parameters to query
1.92 + * @throws ValidationException
1.93 + * when the specified parameter does not occur once
1.94 + */
1.95 + public void assertOne(final String paramName,
1.96 + final ParameterList parameters) throws ValidationException {
1.97 +
1.98 + if (parameters.getParameters(paramName).size() != 1) {
1.99 + throw new ValidationException(ASSERT_ONE_MESSAGE, new Object[] {paramName});
1.100 + }
1.101 + }
1.102 +
1.103 + /**
1.104 + * Ensure a parameter doesn't occur in the specified list.
1.105 + * @param paramName the name of a parameter
1.106 + * @param parameters a list of parameters
1.107 + * @throws ValidationException thrown when the specified property
1.108 + * is found in the list of properties
1.109 + */
1.110 + public void assertNone(final String paramName, final ParameterList parameters) throws ValidationException {
1.111 + if (parameters.getParameter(paramName) != null) {
1.112 + throw new ValidationException(ASSERT_NONE_MESSAGE, new Object[] {paramName});
1.113 + }
1.114 + }
1.115 +
1.116 + /**
1.117 + * @param param a parameter instance
1.118 + * @param parameters a list of parameters
1.119 + * @throws ValidationException where the assertion fails
1.120 + */
1.121 + public void assertNullOrEqual(final Parameter param, final ParameterList parameters) throws ValidationException {
1.122 + final Parameter p = parameters.getParameter(param.getName());
1.123 + if (p != null && !param.equals(p)) {
1.124 + throw new ValidationException(ASSERT_NULL_OR_EQUAL_MESSAGE, new Object[] {p});
1.125 + }
1.126 + }
1.127 +
1.128 + /**
1.129 + * @return Returns the instance.
1.130 + */
1.131 + public static ParameterValidator getInstance() {
1.132 + return instance;
1.133 + }
1.134 +}
