Package org.apache.maven.toolchain.io

Interface ToolchainsReader

  • All Known Implementing Classes:
    DefaultToolchainsReader
    public interface ToolchainsReader
    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 java.lang.String IS_STRICT
      The key for the option to enable strict parsing.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      PersistedToolchains read​(java.io.File input, java.util.Map<java.lang.String,​?> options)
      Reads the toolchains from the specified file.
      PersistedToolchains read​(java.io.InputStream input, java.util.Map<java.lang.String,​?> options)
      Reads the toolchains from the specified byte stream.
      PersistedToolchains read​(java.io.Reader input, java.util.Map<java.lang.String,​?> options)
      Reads the toolchains from the specified character reader.

    • Field Detail

      • IS_STRICT

        static final java.lang.String IS_STRICT
        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:
        Constant Field Values

    • Method Detail

      • read

        PersistedToolchains read​(java.io.File input,
                         java.util.Map<java.lang.String,​?> options)
                  throws java.io.IOException,
                         ToolchainsParseException
        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:
        java.io.IOException - If the toolchains could not be deserialized.
        ToolchainsParseException - If the input format could not be parsed.

      • read

        PersistedToolchains read​(java.io.Reader input,
                         java.util.Map<java.lang.String,​?> options)
                  throws java.io.IOException,
                         ToolchainsParseException
        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:
        java.io.IOException - If the toolchains could not be deserialized.
        ToolchainsParseException - If the input format could not be parsed.

      • read

        PersistedToolchains read​(java.io.InputStream input,
                         java.util.Map<java.lang.String,​?> options)
                  throws java.io.IOException,
                         ToolchainsParseException
        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:
        java.io.IOException - If the toolchains could not be deserialized.
        ToolchainsParseException - If the input format could not be parsed.