ToolchainsReader (Maven Core 3.9.16 API)
JavaScript is disabled on your browser.
   
Skip navigation links
Overview
Class
Use
Tree
Deprecated
Index
Search
Help
org.apache.maven.toolchain.io
ToolchainsReader
Contents 
Description
Field Summary
Method Summary
Field Details
IS_STRICT
Method Details
read(File, Map)
read(Reader, Map)
read(InputStream, Map)
Hide sidebar  Show sidebar
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
Author:
Robert Scholte
Field Summary
Fields
Modifier and Type
Field
Description
static final String
IS_STRICT
The key for the option to enable strict parsing.
Method Summary
All MethodsInstance MethodsAbstract Methods
Modifier and Type
Method
Description
PersistedToolchains
read(File input,
Map<String,?> options)
Reads the toolchains from the specified file.
PersistedToolchains
read(InputStream input,
Map<String,?> options)
Reads the toolchains from the specified byte stream.
PersistedToolchains
read(Reader input,
Map<String,?> options)
Reads the toolchains from the specified character reader.
Field Details
IS_STRICT
static final 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 Details
read
PersistedToolchains read(File input,
Map<String,?> options)
throws 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:
IOException - If the toolchains could not be deserialized.
ToolchainsParseException - If the input format could not be parsed.
read
PersistedToolchains read(Reader input,
Map<String,?> options)
throws 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:
IOException - If the toolchains could not be deserialized.
ToolchainsParseException - If the input format could not be parsed.
read
PersistedToolchains read(InputStream input,
Map<String,?> options)
throws 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:
IOException - If the toolchains could not be deserialized.
ToolchainsParseException - If the input format could not be parsed.
Copyright © 2001–2026 The Apache Software Foundation. All rights reserved.