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 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 028 package org.opends.server.admin; 029 030 031 032 import java.util.Collection; 033 import java.util.Collections; 034 035 036 037 /** 038 * An interface which can be used to initialize the contents of a managed 039 * object. 040 */ 041 public interface PropertyProvider { 042 043 /** 044 * A property provider which always returns empty property values, indicating 045 * default behavior. 046 */ 047 public static final PropertyProvider DEFAULT_PROVIDER = 048 new PropertyProvider() { 049 050 /** 051 * {@inheritDoc} 052 */ 053 public <T> Collection<T> getPropertyValues(PropertyDefinition<T> d) 054 throws IllegalArgumentException { 055 return Collections.<T> emptySet(); 056 } 057 058 }; 059 060 061 062 /** 063 * Get the property values associated with the specified property definition. 064 * <p> 065 * Implementations are not required to validate the values that they provide. 066 * Specifically: 067 * <ul> 068 * <li>they do not need to guarantee that the provided values are valid 069 * according to the property's syntax 070 * <li>they do not need to provide values for mandatory properties 071 * <li>they do not need to ensure that single-valued properties do contain at 072 * most one value. 073 * </ul> 074 * The returned set of values is allowed to contain duplicates. 075 * 076 * @param <T> 077 * The underlying type of the property. 078 * @param d 079 * The Property definition. 080 * @return Returns a newly allocated set containing a copy of the property's 081 * values. An empty set indicates that the property has no values 082 * defined and any default behavior is applicable. 083 * @throws IllegalArgumentException 084 * If this property provider does not recognise the requested 085 * property definition. 086 */ 087 <T> Collection<T> getPropertyValues(PropertyDefinition<T> d) 088 throws IllegalArgumentException; 089 }