Interface Property

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean canBeAssiged​(java.lang.Object value)
      Returns true if the value can be assigned to this property.
      java.lang.String getDescription()
      Returns a description of this property.
      PropertyGroup getGroup()
      Returns the property group that this property belongs to.
      java.lang.String getName()
      Returns the property name.
      java.lang.Class getType()
      Returns the value type of this property.
      java.lang.Object getValue​(java.lang.Object valueContainer)
      Returns the value of this property in a value container.
      boolean isMutable()
      Returns true if this property is mutable.
      void removeValue​(java.lang.Object valueContainer)
      Removes the value of this property from an valueContainer.
      void setValue​(java.lang.Object valueContainer, java.lang.Object value)
      Sets the value of this property in an object.
      boolean valueIsRemovable​(java.lang.Object valueContainer)
      Returns true if the value of this property can be removed from the valueContainer.
      boolean valueIsSet​(java.lang.Object valueContainer)
      Returns true if this property has a value in the valueContainer.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the property name.
        Returns:
        the property name
      • getDescription

        java.lang.String getDescription()
        Returns a description of this property.
        Returns:
        a description of this property
      • getType

        java.lang.Class getType()
        Returns the value type of this property. The property can only be set to values that are of this class or a sub class of this class.
        Returns:
        the value type of this property
      • getGroup

        PropertyGroup getGroup()
        Returns the property group that this property belongs to.
        Returns:
        the property group that this property belongs to
      • getValue

        java.lang.Object getValue​(java.lang.Object valueContainer)
                           throws InvalidPropertyException
        Returns the value of this property in a value container.
        Parameters:
        valueContainer - the object containing the value
        Returns:
        the value of this property in an valueContainer, null if the container doesn't contain the value
        Throws:
        InvalidPropertyException - if the property can not be read from the value container
      • canBeAssiged

        boolean canBeAssiged​(java.lang.Object value)
        Returns true if the value can be assigned to this property.
        Parameters:
        value - the value to assign
        Returns:
        true if the value can be assigned to this property
      • isMutable

        boolean isMutable()
        Returns true if this property is mutable.
        Returns:
        true if this property is mutable
      • valueIsRemovable

        boolean valueIsRemovable​(java.lang.Object valueContainer)
        Returns true if the value of this property can be removed from the valueContainer.
        Parameters:
        valueContainer - the object from which to remove the value
        Returns:
        true if the value of this property can be removed from the valueContainer
      • valueIsSet

        boolean valueIsSet​(java.lang.Object valueContainer)
        Returns true if this property has a value in the valueContainer.
        Parameters:
        valueContainer - the object that might contain the value
        Returns:
        true if this property has a value in the valueContainer