Interface Configurable

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void configure​(java.net.URL base, java.lang.String source, java.lang.String text)
      Configure the object with data from the specified input source (a URL) and/or textual data.
      java.lang.String getConfigureSource()
      Return the input source that was specified the last time the configure method was called.
      java.lang.String getConfigureText()
      Return the text string that represents the current configuration of this object.
    • Method Detail

      • configure

        void configure​(java.net.URL base,
                       java.lang.String source,
                       java.lang.String text)
                throws java.lang.Exception
        Configure the object with data from the specified input source (a URL) and/or textual data. The object should interpret the source first, if it is specified, followed by the literal text, if that is specified. The new configuration should usually override any old configuration wherever possible, in order to ensure that the current state can be successfully retrieved.

        This method is defined to throw a very general exception to allow classes that implement the interface to use whatever exceptions are appropriate.

        Parameters:
        base - The base relative to which references within the input are found, or null if this is not known, or there is none.
        source - The input source, which specifies a URL, or null if none.
        text - Configuration information given as text, or null if none.
        Throws:
        java.lang.Exception - If something goes wrong.
      • getConfigureSource

        java.lang.String getConfigureSource()
        Return the input source that was specified the last time the configure method was called.
        Returns:
        The string representation of the input URL, or null if the no source has been used to configure this object, or null if no external source need be used to configure this object.
      • getConfigureText

        java.lang.String getConfigureText()
        Return the text string that represents the current configuration of this object. Note that any configuration that was previously specified using the source attribute need not be represented here as well.
        Returns:
        A configuration string, or null if no configuration has been used to configure this object, or null if no configuration string need be used to configure this object.