Package com.inet.pdfc.config

Interface IProfile

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    DefaultProfile, SourceProfile, XMLProfile
    public interface IProfile
extends java.io.Serializable
    The PDFC profile containing the various settings for PDFC such as comparison sensitivity, comparison types etc.
    Since:
    4.0

    • Method Detail

      • getObject

        java.lang.Object getObject​(PDFCProperty<?> property)
        Returns the value of the specified PDFCProperty as an Object. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        property - the property to get the value for
        Returns:
        the value as an Object
        My be null if there is no value for the key and the key does not provide a default value.
        Since:
        1.0 in IConfiguration interface

      • getString

        java.lang.String getString​(PDFCProperty<?> property)
        Returns the value of the specified PDFCProperty as a String. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        property - the property to get the value for
        Returns:
        the value as a String
        never null, but may be empty
        Since:
        1.0 in IConfiguration interface

      • getInt

        int getInt​(PDFCProperty<?> property)
        Returns the value of the specified PDFCProperty as an int. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        property - the property to get the value for
        Returns:
        the value as integer
        Since:
        1.0 in IConfiguration interface

      • getDouble

        double getDouble​(PDFCProperty<?> property)
        Returns the value of the specified PDFCProperty as a double. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        property - the property to get the value for
        Returns:
        the value as a double
        Since:
        1.0 in IConfiguration interface

      • getBool

        boolean getBool​(PDFCProperty<?> property)
        Returns the value of the specified PDFCProperty as a boolean. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        property - the property to get the value for
        Returns:
        the value as a boolean.
        Since:
        1.0 in IConfiguration interface

      • putValue

        void putValue​(PDFCProperty<?> property,
              java.lang.String value)
        Stores a property in the current configuration. This value will NOT be saved in the file system but rather is used for the currently running VM instance.
        Parameters:
        property - the property to be stored
        value - the value of the property
        Since:
        1.0 in IConfiguration interface

      • getObject

        java.lang.Object getObject​(java.lang.String propertyName)
        Returns the value of the specified PDFCProperty as an Object. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        propertyName - the name of the property to get the value for
        Returns:
        the value as a Object
        My be null if there is no value for the key and the key does not provide a default value.
        Since:
        1.08 in IConfiguration interface

      • getString

        java.lang.String getString​(java.lang.String propertyName)
        Returns the value of the specified PDFCProperty as a String. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        propertyName - the name of the property to get the value for
        Returns:
        the value as a String
        never null, but may be empty
        Since:
        1.08 in IConfiguration interface

      • getInt

        int getInt​(java.lang.String propertyName)
        Returns the value of the specified PDFCProperty as an int. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        propertyName - the name of the property to get the value for
        Returns:
        the value as an integer
        Since:
        1.08 in IConfiguration interface

      • getDouble

        double getDouble​(java.lang.String propertyName)
        Returns the value of the specified PDFCProperty as a double. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        propertyName - the name of the property to get the value for
        Returns:
        the value as a double
        Since:
        1.08 in IConfiguration interface

      • getBool

        boolean getBool​(java.lang.String propertyName)
        Returns the value of the specified PDFCProperty as a boolean. If it was not specified in the configuration file, the default value will be returned.
        Parameters:
        propertyName - the name of the property to get the value for
        Returns:
        the value as a boolean
        Since:
        1.08 in IConfiguration interface

      • putValue

        void putValue​(java.lang.String propertyName,
              java.lang.String value)
        Stores a property in the current configuration. This value will NOT be saved in the file system but rather is used for the currently running VM instance.
        Parameters:
        propertyName - the name of the property to get the value for
        value - the value of the property, must not be null
        Since:
        1.08 in IConfiguration interface

      • putValues

        void putValues​(java.util.Properties values)
        Stores all properties in the current configuration. This value will NOT be saved in the file system but rather is used for the currently running VM instance. Change events will only be fired for values that have changed.
        Parameters:
        values - the instance of values
        Since:
        4.0 in IConfiguration interface