Class BackendListenerContext


  • public class BackendListenerContext
    extends Object
    BackendListenerContext is used to provide context information to a BackendListenerClient implementation. This currently consists of the initialization parameters which were specified in the GUI.
    Since:
    2.13
    • Constructor Detail

      • BackendListenerContext

        public BackendListenerContext​(Arguments args)
        Parameters:
        args - the initialization parameters.
    • Method Detail

      • containsParameter

        public boolean containsParameter​(String name)
        Determine whether or not a value has been specified for the parameter with this name.
        Parameters:
        name - the name of the parameter to test
        Returns:
        true if the parameter value has been specified, false otherwise.
      • getParameterNamesIterator

        public Iterator<String> getParameterNamesIterator()
        Get an iterator of the parameter names. Each entry in the Iterator is a String.
        Returns:
        an Iterator of Strings listing the names of the parameters which have been specified for this test.
      • getParameter

        public String getParameter​(String name)
        Get the value of a specific parameter as a String, or null if the value was not specified.
        Parameters:
        name - the name of the parameter whose value should be retrieved
        Returns:
        the value of the parameter, or null if the value was not specified
      • getParameter

        public String getParameter​(String name,
                                   String defaultValue)
        Get the value of a specified parameter as a String, or return the specified default value if the value was not specified.
        Parameters:
        name - the name of the parameter whose value should be retrieved
        defaultValue - the default value to return if the value of this parameter was not specified
        Returns:
        the value of the parameter, or the default value if the parameter was not specified
      • getIntParameter

        public int getIntParameter​(String name)
                            throws NumberFormatException
        Get the value of a specified parameter as an integer. An exception will be thrown if the parameter is not specified or if it is not an integer. The value may be specified in decimal, hexadecimal, or octal, as defined by Integer.decode().
        Parameters:
        name - the name of the parameter whose value should be retrieved
        Returns:
        the value of the parameter
        Throws:
        NumberFormatException - if the parameter is not specified or is not an integer
        See Also:
        Integer.decode(java.lang.String)
      • getIntParameter

        public int getIntParameter​(String name,
                                   int defaultValue)
        Get the value of a specified parameter as an integer, or return the specified default value if the value was not specified or is not an integer. A warning will be logged if the value is not an integer. The value may be specified in decimal, hexadecimal, or octal, as defined by Integer.decode().
        Parameters:
        name - the name of the parameter whose value should be retrieved
        defaultValue - the default value to return if the value of this parameter was not specified
        Returns:
        the value of the parameter, or the default value if the parameter was not specified
        See Also:
        Integer.decode(java.lang.String)
      • getLongParameter

        public long getLongParameter​(String name)
                              throws NumberFormatException
        Get the value of a specified parameter as a long. An exception will be thrown if the parameter is not specified or if it is not a long. The value may be specified in decimal, hexadecimal, or octal, as defined by Long.decode().
        Parameters:
        name - the name of the parameter whose value should be retrieved
        Returns:
        the value of the parameter
        Throws:
        NumberFormatException - if the parameter is not specified or is not a long
        See Also:
        Long.decode(String)
      • getLongParameter

        public long getLongParameter​(String name,
                                     long defaultValue)
        Get the value of a specified parameter as along, or return the specified default value if the value was not specified or is not a long. A warning will be logged if the value is not a long. The value may be specified in decimal, hexadecimal, or octal, as defined by Long.decode().
        Parameters:
        name - the name of the parameter whose value should be retrieved
        defaultValue - the default value to return if the value of this parameter was not specified
        Returns:
        the value of the parameter, or the default value if the parameter was not specified
        See Also:
        Long.decode(String)
      • getBooleanParameter

        public boolean getBooleanParameter​(String name,
                                           boolean defaultValue)
        Parameters:
        name - Parameter name
        defaultValue - Default value used if name is not in params
        Returns:
        boolean