Package pulse.util

Class Accessible

  • All Implemented Interfaces:
    Serializable, Descriptive
    Direct Known Subclasses:
    GeneralTask, PropertyHolder
    public abstract class Accessible
extends Group

    An Accessible provides Reflection-based read- and write-access to the underlying (usually declared as its own fields - but not necessarily) instances of Property and a recursive access to other Accessible, which may have a family relationship with this Accessible via the UpwardsNavigable implementation. It also defines its own list of Saveables.

    See Also:
    Serialized Form

    • Constructor Detail

      • Accessible

        public Accessible()

    • Method Detail

      • property

        public Property property​(Property similar)

        Searches for a Property in this Accessible that looks similar to the argument. Determines whether the similar is a NumericProperty or a generic property and calls the suitable method in this class.

        Parameters:
        similar - a generic or a numeric Property
        Returns:
        the matching property of this Accessible

      • numericProperties

        public Set<NumericProperty> numericProperties()
        Tries to access the property getter methods in this Accessible, which should be declared as no-argument methods with a specific return type.
        Returns:
        This will return a unique Set<NumericProperty> containing all instances of NumericProperty belonging to this Accessible. This set will not contain any duplicate elements by definition.

      • genericProperties

        public List<Property> genericProperties()
        Tries to access the property getter methods in this Accessible, which should be declared as no-argument methods with a specific return type.
        Returns:
        This will return a List<Property> containing all properties belonging to this Accessible, which are not assignable from the NumericProperty class.

      • numericProperty

        public NumericProperty numericProperty​(NumericPropertyKeyword type)

        Recursively searches for a NumericProperty from the unique set of numeric properties in this Accessible by comparing its NumericPropertyKeyword to type. This will search for this property through the children of this object, through the children of their children, etc.

        Parameters:
        type - the type of the NumericProperty.
        Returns:
        the respective NumericProperty, or null if nothing is found.
        See Also:
        numericProperties()

      • genericProperty

        public Property genericProperty​(Property sameClass)

        Recursively searches for a Property from the non-unique list of generic properties in this Accessible by comparing its class to sameClass.getClass(). This will search for this property through the children of this object, through the children of their children, etc.

        Parameters:
        sameClass - the class identifying this Property.
        Returns:
        the respective Property, or null if nothing is found.
        See Also:
        genericProperties()

      • set

        public abstract void set​(NumericPropertyKeyword type,
                         NumericProperty property)

        An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

        Parameters:
        type - the type, which must be equal by definition to property.getType().
        property - the property, which contains new information.

      • update

        public void update​(Property property)
        Runs recursive search for a property in this Accessible object with the same identifier as property and sets its value to the value of the property parameter.If property is a NumericProperty, uses its NumericPropertyKeyword for identification. For generic properties, calls attemptUpdate.
        Parameters:
        property - the Property, which will update a similar property of this Accessible.

      • update

        public void update​(NumericProperty p)
        Set a NumericProperty contained in this Accessible or any of its accessible childern, using the NumericPropertyKeyword of the argument as identifier and its value.
        Parameters:
        p - a NumericProperty

      • accessibleChildren

        public List<Accessible> accessibleChildren()

        Selects only those Accessibles, the parent of which is this. Note that all Accessibles are required to explicitly adopt children by calling the setParent() method.

        Returns:
        a List of children that this Accessible has adopted.
        See Also:
        Group.children()