Interface PropertyFileHandle

  • All Known Implementing Classes:
    PropertyFileHandleImpl

    public interface PropertyFileHandle
    This handle is used to read property files and put the values into the HK2 configuration hub. The readFile method can be called multiple times if the file should be read again because the instances or property values may have changed
    Author:
    jwells
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void dispose()
      Will remove any instances added by this handle from the hub, and make it such that this handle can no longer be used
      String getDefaultInstanceName()
      Gets the default instance name that will be given to instances whose name cannot otherwise be determined
      String getDefaultType()
      Returns the default type name if the type cannot be determined from the key of the property.
      String getSpecificType()
      Returns the specific type associated with this handle
      void readProperties​(Properties properties)
      Reads the file associated with this handle and will do the following: Add any type found not previously added by this handle Add any instance found not previously added by this handle Modify any property that has changed value Remove any instance no longer seen in the file but that had previously been added In particular this method will NOT remove a type that was previously added but which has no more instances (other files may be contributing to the same type).
    • Method Detail

      • readProperties

        void readProperties​(Properties properties)
        Reads the file associated with this handle and will do the following:
        • Add any type found not previously added by this handle
        • Add any instance found not previously added by this handle
        • Modify any property that has changed value
        • Remove any instance no longer seen in the file but that had previously been added
          • In particular this method will NOT remove a type that was previously added but which has no more instances (other files may be contributing to the same type). After reaching the end of the input stream this method will close it
        Parameters:
        properties - The properties object to inspect. May not be null
      • getSpecificType

        String getSpecificType()
        Returns the specific type associated with this handle
        Returns:
        The specific type this handle is updating. May return null if this is a multi-type handle
      • getDefaultType

        String getDefaultType()
        Returns the default type name if the type cannot be determined from the key of the property. Will return null if getSpecificType is not null
        Returns:
        The default type name if the type cannot be determined, or null if this handle has a specific type
      • getDefaultInstanceName

        String getDefaultInstanceName()
        Gets the default instance name that will be given to instances whose name cannot otherwise be determined
        Returns:
        The default instance name. Will not return null
      • dispose

        void dispose()
        Will remove any instances added by this handle from the hub, and make it such that this handle can no longer be used