Interface Property

  • All Known Implementing Classes:
    Component, Configuration, Element, Pool, Resource

    public interface Property
    The Property interface specifies the contract between a pools configuration element and its properties. This interface must be implemented by all pools configuration elements to ensure that properties can be manipulated.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getBoolProperty​(java.lang.String name)
      Get a property with the supplied name.
      double getDoubleProperty​(java.lang.String name)
      Get a property with the supplied name.
      long getLongProperty​(java.lang.String name)
      Get a property with the supplied name.
      java.lang.String getStringProperty​(java.lang.String name)
      Get a property with the supplied name.
      void putProperty​(java.lang.String name, Value value)
      Put the supplied value as a property with the supplied name.
      void rmProperty​(java.lang.String name)
      Remove the property with the supplied name.
    • Method Detail

      • getBoolProperty

        boolean getBoolProperty​(java.lang.String name)
                         throws PoolsException
        Get a property with the supplied name.
        Parameters:
        name - The name of the property to be retrieved.
        Throws:
        PoolsException - If there is an error accessing the property.
      • getDoubleProperty

        double getDoubleProperty​(java.lang.String name)
                          throws PoolsException
        Get a property with the supplied name.
        Parameters:
        name - The name of the property to be retrieved.
        Throws:
        PoolsException - If there is an error accessing the property.
      • getLongProperty

        long getLongProperty​(java.lang.String name)
                      throws PoolsException
        Get a property with the supplied name.
        Parameters:
        name - The name of the property to be retrieved.
        Throws:
        PoolsException - If there is an error accessing the property.
      • getStringProperty

        java.lang.String getStringProperty​(java.lang.String name)
                                    throws PoolsException
        Get a property with the supplied name.
        Parameters:
        name - The name of the property to be retrieved.
        Throws:
        PoolsException - If there is an error accessing the property.
      • putProperty

        void putProperty​(java.lang.String name,
                         Value value)
                  throws PoolsException
        Put the supplied value as a property with the supplied name.
        Parameters:
        name - The name of the property to be updated.
        value - The value of the property to be updated.
        Throws:
        PoolsException - If there is an error accessing the property.
      • rmProperty

        void rmProperty​(java.lang.String name)
                 throws PoolsException
        Remove the property with the supplied name.
        Parameters:
        name - The name of the property to be removed.
        Throws:
        PoolsException - If there is an error removing the property.