001package org.apache.maven.toolchain;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.util.Map;
023
024import org.apache.maven.toolchain.model.ToolchainModel;
025
026/**
027 * a private contract between the toolchains plugin and the components.
028 * @author mkleint
029 */
030public interface ToolchainPrivate
031    extends Toolchain
032{
033
034    /**
035     * Let the toolchain decide if it matches requirements defined
036     * in the toolchain plugin configuration.
037     * @param requirements Map<String, String> key value pair, may not be {@code null}
038     * @return {@code true} if the requirements match, otherwise {@code false}
039     */
040    boolean matchesRequirements( Map<String, String> requirements );
041
042    /**
043     * 
044     * @return the original model wrapped by this interface
045     */
046    ToolchainModel getModel();
047
048}