001package org.apache.maven;
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.io.File;
023import java.util.LinkedHashMap;
024import java.util.List;
025import java.util.Map;
026
027/**
028 * Signals a collision of two or more projects with the same g:a:v during a reactor build.
029 * 
030 * @author Benjamin Bentmann
031 */
032public class DuplicateProjectException
033    extends MavenExecutionException
034{
035
036    private Map<String, List<File>> collisions;
037
038    /**
039     * Creates a new exception with specified details.
040     * 
041     * @param message The message text, may be {@code null}.
042     * @param collisions The POM files of the projects that collided, indexed by their g:a:v, may be {@code null}.
043     */
044    public DuplicateProjectException( String message, Map<String, List<File>> collisions )
045    {
046        super( message, (File) null );
047
048        this.collisions = ( collisions != null ) ? collisions : new LinkedHashMap<String, List<File>>();
049    }
050
051    /**
052     * Gets the POM files of the projects that collided.
053     * 
054     * @return The POM files of the projects that collided, indexed by their g:a:v, never {@code null}.
055     */
056    public Map<String, List<File>> getCollisions()
057    {
058        return collisions;
059    }
060
061}