1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services;
20
21 import java.util.Optional;
22
23 import org.apache.maven.api.Toolchain;
24 import org.apache.maven.api.annotations.Consumer;
25 import org.apache.maven.api.annotations.Experimental;
26 import org.apache.maven.api.annotations.Nonnull;
27 import org.apache.maven.api.toolchain.ToolchainModel;
28
29 /**
30 * Factory interface for creating toolchain instances from configuration models.
31 *
32 * <p>This factory is responsible for instantiating concrete toolchain implementations
33 * based on toolchain model configurations or default settings.</p>
34 *
35 * @since 4.0.0
36 */
37 @Experimental
38 @Consumer
39 public interface ToolchainFactory {
40 /**
41 * Creates a toolchain instance from the provided model configuration.
42 *
43 * @param model The toolchain configuration model
44 * @return A configured toolchain instance
45 * @throws ToolchainFactoryException if toolchain creation fails
46 */
47 @Nonnull
48 Toolchain createToolchain(@Nonnull ToolchainModel model) throws ToolchainFactoryException;
49
50 /**
51 * Creates a default toolchain instance using system defaults.
52 *
53 * @return Optional containing the default toolchain if available
54 * @throws ToolchainFactoryException if default toolchain creation fails
55 */
56 @Nonnull
57 Optional<Toolchain> createDefaultToolchain() throws ToolchainFactoryException;
58 }