compiler/src/main/java/org/apache/royale/compiler/exceptions/CircularDependencyException.java

/*
 *
 *  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.
 *
 */

package org.apache.royale.compiler.exceptions;

import java.util.List;

import com.google.common.collect.ImmutableList;

/**
 * Exception thrown when a graph is found to contain a circular dependency.
 */
public class CircularDependencyException extends Exception
{
    private static final long serialVersionUID = 385233752444704292L;

    /**
     * Create a new CircularDependencyException.
     */
    public CircularDependencyException()
    {
    }
    
    private List<?> circularDependency;
    
    /**
     * Creates a new CircularDependencyException with a circular dependency 
     * that caused the exception.
     * 
     * @param circularDependency List of vertexes that caused the circular 
     * dependency.
     */
    public CircularDependencyException(List<?> circularDependency)
    {
        this.circularDependency = circularDependency;
    }    
    
    /**
     * Get the details of the circular dependency. 
     * 
     * @return List of vertexes that caused the circular dependency.
     */
    public ImmutableList<?> getCircularDependency()
    {
        return ImmutableList.copyOf(circularDependency);
    }
}