Package org.jdesktop.beansbinding

Class Property<S,​V>

  • Type Parameters:
    S - the type of source object that this Property operates on
    V - the type of value that this Property represents
    Direct Known Subclasses:
    ObjectProperty, PropertyHelper
    public abstract class Property<S,​V>
extends Object
    Property defines a uniform way to access the value of a property. A typical Property implemention allows you to create an immutable representation of a way to derive some property from a source object. As such, all methods of this class take a source object as an argument.

    A Property implementation may, however, be designed such that the Property itself is a mutable thing that stores a property value. In such a case, the Property implementation may ignore the source object. Property implementations should clearly document their behavior in this regard.

    You can listen for changes in the state of a Property by registering PropertyStateListeners on the Property.

    Author:
    Shannon Hickey

    • Constructor Detail

      • Property

        public Property()

    • Method Detail

      • getWriteType

        public abstract Class<? extends V> getWriteType​(S source)
        Returns the type of object that is suitable for setting as the value of this Property by calls to setValue.
        Parameters:
        source - the source object on which to operate
        Returns:
        the type of object suitable for setting as the value
        Throws:
        UnsupportedOperationException - if the Property is not writeable for the given source
        See Also:
        setValue(S, V), isWriteable(S)

      • getValue

        public abstract V getValue​(S source)
        Returns the value of this Property for the given source.
        Parameters:
        source - the source object on which to operate
        Returns:
        the value of this Property for the given source
        Throws:
        UnsupportedOperationException - if the Property is not readable for the given source
        See Also:
        isReadable(S)

      • setValue

        public abstract void setValue​(S source,
                              V value)
        Sets the value of this Property for the given source.
        Parameters:
        source - the source object on which to operate
        value - the new value for the Property
        Throws:
        UnsupportedOperationException - if the Property is not writeable for the given source
        See Also:
        isWriteable(S), getWriteType(S)

      • isReadable

        public abstract boolean isReadable​(S source)
        Returns whether or not the Property is readable for the given source.
        Parameters:
        source - the source object on which to operate
        Returns:
        whether or not the Property is readable for the given source.
        See Also:
        isWriteable(S)

      • isWriteable

        public abstract boolean isWriteable​(S source)
        Returns whether or not the Property is writeable for the given source.
        Parameters:
        source - the source object on which to operate
        Returns:
        whether or not the Property is writeable for the given source.
        See Also:
        isReadable(S)

      • addPropertyStateListener

        public abstract void addPropertyStateListener​(S source,
                                              PropertyStateListener listener)
        Adds a PropertyStateListener to be notified when the state of the Property changes with respect to the given source. Does nothing if the listener is null. If a listener is added more than once, notifications are sent to that listener once for every time that it has been added. The ordering of listener notification is unspecified.
        Parameters:
        source - the source object on which to operate
        listener - the listener to be notified

      • removePropertyStateListener

        public abstract void removePropertyStateListener​(S source,
                                                 PropertyStateListener listener)
        Removes a PropertyStateListener for the given source. Does nothing if the listener is null or is not one of those registered for this source object. If the listener being removed was registered more than once, only one occurrence of the listener is removed from the list of listeners. The ordering of listener notification is unspecified.
        Parameters:
        source - the source object on which to operate
        listener - the listener to be removed
        See Also:
        addPropertyStateListener(S, org.jdesktop.beansbinding.PropertyStateListener)