Hervé Boutemy
 -----
 2006-11-04
 -----

Maven Toolchain Model

 This is the model for Maven toolchain in <<<org.apache.maven.toolchain>>> package,
 delegating content to {{{../api/maven-api-toolchain/index.html}Maven 4 API immutable toolchain}}. All the effective model
 building logic from multiple toolchains files is done in {{{../maven-toolchain-builder/}Maven Toolchain Builder}}.

 The following are generated from this model:

     * @param requirements
     * @return the selected {@link Toolchain}s
     * @throws ToolchainManagerException if an exception occurs
     */
    @Nonnull
    List<Toolchain> getToolchains(@Nonnull Session session, String type, Map<String, String> requirements);

    /**
     *
     * @param session
     * @param type
     * @return the selected {@link Toolchain}
     * @throws ToolchainManagerException if an exception occurs

    <relativePath>../../</relativePath>
  </parent>

  <artifactId>maven-toolchain-model</artifactId>

  <name>Maven Toolchain Model</name>
  <description>Maven Toolchain model.</description>

  <dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-api-toolchain</artifactId>
    </dependency>
    <dependency>
      <groupId>org.apache.maven</groupId>

under the License.
-->

<toolchains>
  <toolchain>
     <type>basic</type>
     <configuration>
       <global>true</global>
     </configuration>
  </toolchain>
  <toolchain>
     <type>rare</type>
     <configuration>
       <global>true</global>
     </configuration>
  </toolchain>

        try (Writer out = output) {
            new MavenToolchainsStaxWriter().write(out, toolchains.getDelegate());
        } catch (XMLStreamException e) {
            throw new IOException("Error writing toolchains", e);
        }
    }

    /**
     * Builds the toolchains model from the configured toolchain files.
     *
     * @param userToolchainsFile The path to the toolchains file, may be <code>null</code> to disable parsing.
     * @return The toolchains model or <code>null</code> if no toolchain file was configured or the configured file does
     *         not exist.
     * @throws MisconfiguredToolchainException If the toolchain file exists but cannot be parsed.
     */

import org.apache.maven.api.annotations.Experimental;

/**
 * Represents a Java toolchain in the Maven build system.
 *
 * <p>A Java toolchain is a specific type of toolchain that provides access
 * to Java development tools, such as the Java compiler and Java runtime
 * environment. This interface allows users to define and configure
 * Java-related toolchains that can be utilized during the build process
 * in Maven.</p>
 *

specific language governing permissions and limitations
under the License.
-->

<toolchains>
  <toolchain>
     <type>basic</type>
     <configuration>
       <user>true</user>
     </configuration>
  </toolchain>
  <toolchain>
     <type>rare</type>
     <configuration>
       <user>true</user>
     </configuration>
  </toolchain>

 * under the License.
 */
package org.apache.maven.toolchain;

import javax.inject.Named;
import javax.inject.Singleton;

import java.io.File;
import java.io.InputStream;
import java.nio.file.Files;

import org.apache.maven.toolchain.model.PersistedToolchains;
import org.apache.maven.toolchain.v4.MavenToolchainsStaxReader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**

              <exclude>org.apache.maven.toolchain.DefaultToolchain#getLog():METHOD_RETURN_TYPE_CHANGED</exclude>
              <exclude>org.apache.maven.toolchain.DefaultToolchain#DefaultToolchain(org.apache.maven.toolchain.model.ToolchainModel,org.codehaus.plexus.logging.Logger):CONSTRUCTOR_REMOVED</exclude>