View Javadoc
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.List;
22  
23  import org.apache.maven.api.annotations.Experimental;
24  import org.apache.maven.api.annotations.Nonnull;
25  import org.apache.maven.api.toolchain.PersistedToolchains;
26  
27  /**
28   *
29   * @since 4.0.0
30   */
31  @Experimental
32  public interface ToolchainsBuilderResult {
33      /**
34       * Gets the assembled toolchains.
35       *
36       * @return the assembled toolchains, never {@code null}
37       */
38      @Nonnull
39      PersistedToolchains getEffectiveToolchains();
40  
41      /**
42       * Gets the problems that were encountered during the settings building. Note that only problems of severity
43       * {@link BuilderProblem.Severity#WARNING} and below are reported here. Problems with a higher severity level cause
44       * the settings builder to fail with a {@link ToolchainsBuilderException}.
45       *
46       * @return the problems that were encountered during the settings building, can be empty but never {@code null}
47       */
48      @Nonnull
49      List<BuilderProblem> getProblems();
50  }