Package org.apache.logging.converter.config.spi

Interface ConfigurationMapper

All Superinterfaces:
ConfigurationParser, ConfigurationWriter
@ProviderType public interface ConfigurationMapper extends ConfigurationParser, ConfigurationWriter
Interface for format provider classes that implement a parser and a writer at the same time.

Implementations of this class should be registered with ServiceLoader.

  • Method Details

    • getFormat

      String getFormat()
      A short string that identifies the format supported by this mapper.

      For example, "v2:xml" or "v1:properties".

    • getFormatDescription

      String getFormatDescription()
      A description of the supported format for self-documentation purposes.

    • getInputFormat

      default String getInputFormat()
      Description copied from interface: ConfigurationParser
      A short string that identifies the format supported by this parser.

      For example, "v2:xml" or "v1:properties".

      Specified by:
      getInputFormat in interface ConfigurationParser

    • getInputFormatDescription

      default String getInputFormatDescription()
      Description copied from interface: ConfigurationParser
      A description of the supported format for self-documentation purposes.
      Specified by:
      getInputFormatDescription in interface ConfigurationParser

    • getOutputFormat

      default String getOutputFormat()
      Description copied from interface: ConfigurationWriter
      A short string that identifies the format supported by this writer.

      For example, "v2:xml" or "v1:properties".

      Specified by:
      getOutputFormat in interface ConfigurationWriter

    • getOutputFormatDescription

      default String getOutputFormatDescription()
      Description copied from interface: ConfigurationWriter
      A description of the supported format for self-documentation purposes.
      Specified by:
      getOutputFormatDescription in interface ConfigurationWriter