View Javadoc

1   package org.apache.maven.toolchain;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Map;
23  
24  import org.apache.maven.toolchain.model.ToolchainModel;
25  
26  /**
27   * a private contract between the toolchains plugin and the components.
28   * @author mkleint
29   */
30  public interface ToolchainPrivate
31      extends Toolchain
32  {
33  
34      /**
35       * Let the toolchain decide if it matches requirements defined
36       * in the toolchain plugin configuration.
37       * @param requirements Map<String, String> key value pair
38       * @return {@code true} if the requirements match, otherwise {@code false}
39       */
40      boolean matchesRequirements( Map<String, String> requirements );
41  
42      ToolchainModel getModel();
43  
44  }