Package org.forgerock.opendj.config.client.spi

Interface Property<T>

  • Type Parameters:
    T - The type of the property.
    public interface Property<T>
    A managed object property comprising of the property's definition and its set of values.

    The property stores the values in a sorted set in which values are compared using the comparator defined by the property definition.

    The property keeps track of whether its pending set of values differs from its active values.

    • Method Detail

      • getActiveValues

        SortedSet<ValueOrExpression<T>> getActiveValues()
        Get an immutable set view of this property's active values.
        Returns:
        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.

      • getDefaultValues

        SortedSet<ValueOrExpression<T>> getDefaultValues()
        Get an immutable set view of this property's default values.
        Returns:
        Returns an immutable set view of this property's default values. An empty set indicates that there are no default values.

      • getEffectiveValues

        SortedSet<ValueOrExpression<T>> getEffectiveValues()
        Get an immutable set view of this property's effective values.
        Returns:
        Returns an immutable set view of this property's effective values.

      • getPendingValues

        SortedSet<ValueOrExpression<T>> getPendingValues()
        Get an immutable set view of this property's pending values.

        Immediately after construction, the pending values matches the active values.

        Returns:
        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.

      • getPropertyDefinition

        PropertyDefinition<T> getPropertyDefinition()
        Get the property definition associated with this property.
        Returns:
        Returns the property definition associated with this property.

      • isEmpty

        boolean isEmpty()
        Determines whether this property contains any pending values.
        Returns:
        Returns true if this property does not contain any pending values.

      • isModified

        boolean isModified()
        Determines whether this property has been modified since it was constructed. In other words, whether the set of pending values differs from the set of active values.
        Returns:
        Returns true if this property has been modified since it was constructed.

      • wasEmpty

        boolean wasEmpty()
        Determines whether this property contains any active values.
        Returns:
        Returns true if this property does not contain any active values.