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

Tue, 10 Feb 2015 18:12:00 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 10 Feb 2015 18:12:00 +0100
changeset 0
fb9019fb1bf7
permissions
-rw-r--r--

Import initial revisions of existing project AndroidCaldavSyncAdapater,
forked from upstream repository at 27e8a0f8495c92e0780d450bdf0c7cec77a03a55.

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

mercurial