org.apache.maven.plugin.ear.output.FileNameMapping Maven / Gradle / Ivy

Go to download
package org.apache.maven.plugin.ear.output;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.maven.artifact.Artifact;

/**
 * Maps file name {@link Artifact}.
 * 
 * TODO: it might be easier to use a token-based approach instead.
 * 
 * @author Stephane Nicoll
 * @version $Id: FileNameMapping.java 1645331 2014-12-13 17:31:09Z khmarbaise $
 */
public interface FileNameMapping
{

    /**
     * @param useBaseVersion true if the base version will be use false otherwise.
     */
    void setUseBaseVersion( boolean useBaseVersion );

    /**
     * Returns the file name of the specified artifact.
     * 
     * @param a the artifact
     * @return the name of the file for the specified artifact
     */
    String mapFileName( final Artifact a );
}