001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026
027package org.forgerock.opendj.config;
028
029import java.util.Collection;
030import java.util.Collections;
031
032/**
033 * An interface which can be used to initialize the contents of a managed
034 * object.
035 */
036public interface PropertyProvider {
037
038    /**
039     * A property provider which always returns empty property values,
040     * indicating default behavior.
041     */
042    PropertyProvider DEFAULT_PROVIDER = new PropertyProvider() {
043
044        /** {@inheritDoc} */
045        public <T> Collection<T> getPropertyValues(PropertyDefinition<T> d) {
046            return Collections.<T> emptySet();
047        }
048
049    };
050
051    /**
052     * Get the property values associated with the specified property
053     * definition.
054     * <p>
055     * Implementations are not required to validate the values that they
056     * provide. Specifically:
057     * <ul>
058     * <li>they do not need to guarantee that the provided values are valid
059     * according to the property's syntax
060     * <li>they do not need to provide values for mandatory properties
061     * <li>they do not need to ensure that single-valued properties do contain
062     * at most one value.
063     * </ul>
064     * The returned set of values is allowed to contain duplicates.
065     *
066     * @param <T>
067     *            The underlying type of the property.
068     * @param d
069     *            The Property definition.
070     * @return Returns a newly allocated set containing a copy of the property's
071     *         values. An empty set indicates that the property has no values
072     *         defined and any default behavior is applicable.
073     * @throws IllegalArgumentException
074     *             If this property provider does not recognise the requested
075     *             property definition.
076     */
077    <T> Collection<T> getPropertyValues(PropertyDefinition<T> d);
078}