michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.util;
michael@0: 
michael@0: import net.fortuna.ical4j.model.PropertyList;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: 
michael@0: /**
michael@0:  * $Id$ [15-May-2004]
michael@0:  *
michael@0:  * Defines methods for validating properties and property lists.
michael@0:  *
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public final class PropertyValidator {
michael@0: 
michael@0:     private static final String ASSERT_NONE_MESSAGE = "Property [{0}] is not applicable";
michael@0: 
michael@0:     private static final String ASSERT_ONE_OR_LESS_MESSAGE = "Property [{0}] must only be specified once";
michael@0: 
michael@0:     private static final String ASSERT_ONE_MESSAGE = "Property [{0}] must be specified once";
michael@0: 
michael@0:     private static final String ASSERT_ONE_OR_MORE_MESSAGE = "Property [{0}] must be specified at least once";
michael@0: 
michael@0:     private static PropertyValidator instance = new PropertyValidator();
michael@0: 
michael@0:     /**
michael@0:      * Constructor made private to enforce singleton.
michael@0:      */
michael@0:     private PropertyValidator() {
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Ensure a property occurs no more than once.
michael@0:      *
michael@0:      * @param propertyName
michael@0:      *            the property name
michael@0:      * @param properties
michael@0:      *            a list of properties to query
michael@0:      * @throws ValidationException
michael@0:      *             when the specified property occurs more than once
michael@0:      */
michael@0:     public void assertOneOrLess(final String propertyName,
michael@0:             final PropertyList properties) throws ValidationException {
michael@0: 
michael@0:         if (properties.getProperties(propertyName).size() > 1) {
michael@0:             throw new ValidationException(ASSERT_ONE_OR_LESS_MESSAGE, new Object[] {propertyName});
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Ensure a property occurs at least once.
michael@0:      *
michael@0:      * @param propertyName
michael@0:      *            the property name
michael@0:      * @param properties
michael@0:      *            a list of properties to query
michael@0:      * @throws ValidationException
michael@0:      *             when the specified property occurs more than once
michael@0:      */
michael@0:     public void assertOneOrMore(final String propertyName,
michael@0:             final PropertyList properties) throws ValidationException {
michael@0: 
michael@0:         if (properties.getProperties(propertyName).size() < 1) {
michael@0:             throw new ValidationException(ASSERT_ONE_OR_MORE_MESSAGE, new Object[] {propertyName});
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Ensure a property occurs once.
michael@0:      *
michael@0:      * @param propertyName
michael@0:      *            the property name
michael@0:      * @param properties
michael@0:      *            a list of properties to query
michael@0:      * @throws ValidationException
michael@0:      *             when the specified property does not occur once
michael@0:      */
michael@0:     public void assertOne(final String propertyName,
michael@0:             final PropertyList properties) throws ValidationException {
michael@0: 
michael@0:         if (properties.getProperties(propertyName).size() != 1) {
michael@0:             throw new ValidationException(ASSERT_ONE_MESSAGE, new Object[] {propertyName});
michael@0:         }
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * Ensure a property doesn't occur in the specified list.
michael@0:      * @param propertyName the name of a property
michael@0:      * @param properties a list of properties
michael@0:      * @throws ValidationException thrown when the specified property
michael@0:      * is found in the list of properties
michael@0:      */
michael@0:     public void assertNone(final String propertyName, final PropertyList properties) throws ValidationException {
michael@0:         if (properties.getProperty(propertyName) != null) {
michael@0:             throw new ValidationException(ASSERT_NONE_MESSAGE, new Object[] {propertyName});
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return Returns the instance.
michael@0:      */
michael@0:     public static PropertyValidator getInstance() {
michael@0:         return instance;
michael@0:     }
michael@0: }