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
022/**
023 * Toolchain interface.
024 *
025 * @author Milos Kleint
026 * @author Jason van Zyl
027 * @since 2.0.9
028 */
029public interface Toolchain
030{
031
032    /**
033     * get the type of toolchain.
034     *
035     * @return the toolchain type
036     */
037    String getType();
038
039    /**
040     * Gets the platform tool executable.
041     *
042     * @param toolName the tool platform independent tool name.
043     * @return file representing the tool executable, or null if the tool can not be found
044     */
045    String findTool( String toolName );
046}