Interface ToolchainsReader

All Known Implementing Classes:
DefaultToolchainsReader
@Deprecated(since="4.0.0") public interface ToolchainsReader
Deprecated.
since 4.0.0, use org.apache.maven.api.services.xml.ToolchainsXmlFactory instead
Handles deserialization of toolchains from some kind of textual format like XML.
Since:
3.3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    IS_STRICT
    Deprecated.
    The key for the option to enable strict parsing.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.maven.toolchain.model.PersistedToolchains
    read(File input, Map<String,?> options)
    Deprecated.
    Reads the toolchains from the specified file.
    org.apache.maven.toolchain.model.PersistedToolchains
    read(InputStream input, Map<String,?> options)
    Deprecated.
    Reads the toolchains from the specified byte stream.
    org.apache.maven.toolchain.model.PersistedToolchains
    read(Reader input, Map<String,?> options)
    Deprecated.
    Reads the toolchains from the specified character reader.

  • Field Details

    • IS_STRICT

      static final String IS_STRICT
      Deprecated.
      The key for the option to enable strict parsing. This option is of type Boolean and defaults to true. If false, unknown elements will be ignored instead of causing a failure.
      See Also:

  • Method Details

    • read

      org.apache.maven.toolchain.model.PersistedToolchains read(File input, Map<String,?> options) throws IOException, ToolchainsParseException
      Deprecated.
      Reads the toolchains from the specified file.
      Parameters:
      input - The file to deserialize the toolchains from, must not be null.
      options - The options to use for deserialization, may be null to use the default values.
      Returns:
      The deserialized toolchains, never null.
      Throws:
      IOException - If the toolchains could not be deserialized.
      ToolchainsParseException - If the input format could not be parsed.

    • read

      org.apache.maven.toolchain.model.PersistedToolchains read(Reader input, Map<String,?> options) throws IOException, ToolchainsParseException
      Deprecated.
      Reads the toolchains from the specified character reader. The reader will be automatically closed before the method returns.
      Parameters:
      input - The reader to deserialize the toolchains from, must not be null.
      options - The options to use for deserialization, may be null to use the default values.
      Returns:
      The deserialized toolchains, never null.
      Throws:
      IOException - If the toolchains could not be deserialized.
      ToolchainsParseException - If the input format could not be parsed.

    • read

      org.apache.maven.toolchain.model.PersistedToolchains read(InputStream input, Map<String,?> options) throws IOException, ToolchainsParseException
      Deprecated.
      Reads the toolchains from the specified byte stream. The stream will be automatically closed before the method returns.
      Parameters:
      input - The stream to deserialize the toolchains from, must not be null.
      options - The options to use for deserialization, may be null to use the default values.
      Returns:
      The deserialized toolchains, never null.
      Throws:
      IOException - If the toolchains could not be deserialized.
      ToolchainsParseException - If the input format could not be parsed.