1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/util/PropertyValidator.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,135 @@
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.PropertyList;
1.38 +import net.fortuna.ical4j.model.ValidationException;
1.39 +
1.40 +/**
1.41 + * $Id$ [15-May-2004]
1.42 + *
1.43 + * Defines methods for validating properties and property lists.
1.44 + *
1.45 + * @author Ben Fortuna
1.46 + */
1.47 +public final class PropertyValidator {
1.48 +
1.49 + private static final String ASSERT_NONE_MESSAGE = "Property [{0}] is not applicable";
1.50 +
1.51 + private static final String ASSERT_ONE_OR_LESS_MESSAGE = "Property [{0}] must only be specified once";
1.52 +
1.53 + private static final String ASSERT_ONE_MESSAGE = "Property [{0}] must be specified once";
1.54 +
1.55 + private static final String ASSERT_ONE_OR_MORE_MESSAGE = "Property [{0}] must be specified at least once";
1.56 +
1.57 + private static PropertyValidator instance = new PropertyValidator();
1.58 +
1.59 + /**
1.60 + * Constructor made private to enforce singleton.
1.61 + */
1.62 + private PropertyValidator() {
1.63 + }
1.64 +
1.65 + /**
1.66 + * Ensure a property occurs no more than once.
1.67 + *
1.68 + * @param propertyName
1.69 + * the property name
1.70 + * @param properties
1.71 + * a list of properties to query
1.72 + * @throws ValidationException
1.73 + * when the specified property occurs more than once
1.74 + */
1.75 + public void assertOneOrLess(final String propertyName,
1.76 + final PropertyList properties) throws ValidationException {
1.77 +
1.78 + if (properties.getProperties(propertyName).size() > 1) {
1.79 + throw new ValidationException(ASSERT_ONE_OR_LESS_MESSAGE, new Object[] {propertyName});
1.80 + }
1.81 + }
1.82 +
1.83 + /**
1.84 + * Ensure a property occurs at least once.
1.85 + *
1.86 + * @param propertyName
1.87 + * the property name
1.88 + * @param properties
1.89 + * a list of properties to query
1.90 + * @throws ValidationException
1.91 + * when the specified property occurs more than once
1.92 + */
1.93 + public void assertOneOrMore(final String propertyName,
1.94 + final PropertyList properties) throws ValidationException {
1.95 +
1.96 + if (properties.getProperties(propertyName).size() < 1) {
1.97 + throw new ValidationException(ASSERT_ONE_OR_MORE_MESSAGE, new Object[] {propertyName});
1.98 + }
1.99 + }
1.100 +
1.101 + /**
1.102 + * Ensure a property occurs once.
1.103 + *
1.104 + * @param propertyName
1.105 + * the property name
1.106 + * @param properties
1.107 + * a list of properties to query
1.108 + * @throws ValidationException
1.109 + * when the specified property does not occur once
1.110 + */
1.111 + public void assertOne(final String propertyName,
1.112 + final PropertyList properties) throws ValidationException {
1.113 +
1.114 + if (properties.getProperties(propertyName).size() != 1) {
1.115 + throw new ValidationException(ASSERT_ONE_MESSAGE, new Object[] {propertyName});
1.116 + }
1.117 + }
1.118 +
1.119 + /**
1.120 + * Ensure a property doesn't occur in the specified list.
1.121 + * @param propertyName the name of a property
1.122 + * @param properties a list of properties
1.123 + * @throws ValidationException thrown when the specified property
1.124 + * is found in the list of properties
1.125 + */
1.126 + public void assertNone(final String propertyName, final PropertyList properties) throws ValidationException {
1.127 + if (properties.getProperty(propertyName) != null) {
1.128 + throw new ValidationException(ASSERT_NONE_MESSAGE, new Object[] {propertyName});
1.129 + }
1.130 + }
1.131 +
1.132 + /**
1.133 + * @return Returns the instance.
1.134 + */
1.135 + public static PropertyValidator getInstance() {
1.136 + return instance;
1.137 + }
1.138 +}
