Fix issue 1734: Admin framework: refactor client APIs

matthew_swift

01.06.2007 70298b0c8e01f5df3a5f766f3624bed0ac8c2695

 opends/src/server/org/opends/server/admin/client/spi/Property.java

File was renamed from opends/src/server/org/opends/server/admin/client/Property.java
@@ -25,7 +25,7 @@
 *      Portions Copyright 2007 Sun Microsystems, Inc.
 */

package org.opends.server.admin.client;
package org.opends.server.admin.client.spi;



@@ -36,28 +36,26 @@


/**
 * A managed object property comprising of the property's definition and its set
 * of values.
 * A managed object property comprising of the property's definition
 * and its set of values.
 * <p>
 * The property stores the values in a sorted set in which values are compared
 * using the comparator defined by the property definition.
 * The property stores the values in a sorted set in which values are
 * compared using the comparator defined by the property definition.
 * <p>
 * The property keeps track of whether or not its pending set of values differs
 * from its active values.
 * The property keeps track of whether or not its pending set of
 * values differs from its active values.
 *
 * @param <T>
 *          The type of the property.
 * @see ManagedObject The <code>ManagedObject</code> documentation describes
 *      the different types of property values in more detail.
 */
public interface Property<T> {

  /**
   * Get an immutable set view of this property's active values.
   *
   * @return Returns an immutable set view of this property's active values. An
   *         empty set indicates that there are no active values, and any
   *         default values are applicable.
   * @return Returns an immutable set view of this property's active
   *         values. An empty set indicates that there are no active
   *         values, and any default values are applicable.
   */
  SortedSet<T> getActiveValues();

@@ -66,8 +64,9 @@
  /**
   * Get an immutable set view of this property's default values.
   *
   * @return Returns an immutable set view of this property's default values. An
   *         empty set indicates that there are no default values.
   * @return Returns an immutable set view of this property's default
   *         values. An empty set indicates that there are no default
   *         values.
   */
  SortedSet<T> getDefaultValues();

@@ -76,7 +75,8 @@
  /**
   * Get an immutable set view of this property's effective values.
   *
   * @return Returns an immutable set view of this property's effective values.
   * @return Returns an immutable set view of this property's
   *         effective values.
   */
  SortedSet<T> getEffectiveValues();

@@ -85,12 +85,12 @@
  /**
   * Get an immutable set view of this property's pending values.
   * <p>
   * Immediately after construction, the pending values matches the active
   * values.
   * Immediately after construction, the pending values matches the
   * active values.
   *
   * @return Returns an immutable set view of this property's pending values. An
   *         empty set indicates that there are no pending values, and any
   *         default values are applicable.
   * @return Returns an immutable set view of this property's pending
   *         values. An empty set indicates that there are no pending
   *         values, and any default values are applicable.
   */
  SortedSet<T> getPendingValues();

@@ -99,39 +99,42 @@
  /**
   * Get the property definition associated with this property.
   *
   * @return Returns the property definition associated with this property.
   * @return Returns the property definition associated with this
   *         property.
   */
  PropertyDefinition<T> getPropertyDefinition();



  /**
   * Determines whether or not this property contains any pending values.
   * Determines whether or not this property contains any pending
   * values.
   *
   * @return Returns <code>true</code> if this property does not contain any
   *         pending values.
   * @return Returns <code>true</code> if this property does not
   *         contain any pending values.
   */
  boolean isEmpty();



  /**
   * Determines whether or not this property has been modified since it was
   * constructed. In other words, whether or not the set of pending values
   * differs from the set of active values.
   * Determines whether or not this property has been modified since
   * it was constructed. In other words, whether or not the set of
   * pending values differs from the set of active values.
   *
   * @return Returns <code>true</code> if this property has been modified
   *         since it was constructed.
   * @return Returns <code>true</code> if this property has been
   *         modified since it was constructed.
   */
  boolean isModified();



  /**
   * Determines whether or not this property contains any active values.
   * Determines whether or not this property contains any active
   * values.
   *
   * @return Returns <code>true</code> if this property does not contain any
   *         active values.
   * @return Returns <code>true</code> if this property does not
   *         contain any active values.
   */
  boolean wasEmpty();
}