package org.eclipse.aether.resolution;

/*
 * 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.eclipse.aether.RepositoryException;

Thrown in case of an unreadable or unresolvable artifact descriptor.
/**
 * Thrown in case of an unreadable or unresolvable artifact descriptor.
 */
public class ArtifactDescriptorException
    extends RepositoryException
{

    private final transient ArtifactDescriptorResult result;

    
Creates a new exception with the specified result.
Params:
result – The descriptor result at the point the exception occurred, may be null./**
     * Creates a new exception with the specified result.
     * 
     * @param result The descriptor result at the point the exception occurred, may be {@code null}.
     */
    public ArtifactDescriptorException( ArtifactDescriptorResult result )
    {
        super( "Failed to read artifact descriptor"
            + ( result != null ? " for " + result.getRequest().getArtifact() : "" ), getCause( result ) );
        this.result = result;
    }

    
Creates a new exception with the specified result and detail message.
Params:
result – The descriptor result at the point the exception occurred, may be null.
message – The detail message, may be null./**
     * Creates a new exception with the specified result and detail message.
     * 
     * @param result The descriptor result at the point the exception occurred, may be {@code null}.
     * @param message The detail message, may be {@code null}.
     */
    public ArtifactDescriptorException( ArtifactDescriptorResult result, String message )
    {
        super( message, getCause( result ) );
        this.result = result;
    }

    
Creates a new exception with the specified result, detail message and cause.
Params:
result – The descriptor result at the point the exception occurred, may be null.
message – The detail message, may be null.
cause – The exception that caused this one, may be null./**
     * Creates a new exception with the specified result, detail message and cause.
     * 
     * @param result The descriptor result at the point the exception occurred, may be {@code null}.
     * @param message The detail message, may be {@code null}.
     * @param cause The exception that caused this one, may be {@code null}.
     */
    public ArtifactDescriptorException( ArtifactDescriptorResult result, String message, Throwable cause )
    {
        super( message, cause );
        this.result = result;
    }

    
Gets the descriptor result at the point the exception occurred. Despite being incomplete, callers might want to
use this result to fail gracefully and continue their operation with whatever interim data has been gathered.
Returns:
The descriptor result or null if unknown./**
     * Gets the descriptor result at the point the exception occurred. Despite being incomplete, callers might want to
     * use this result to fail gracefully and continue their operation with whatever interim data has been gathered.
     * 
     * @return The descriptor result or {@code null} if unknown.
     */
    public ArtifactDescriptorResult getResult()
    {
        return result;
    }

    private static Throwable getCause( ArtifactDescriptorResult result )
    {
        Throwable cause = null;
        if ( result != null && !result.getExceptions().isEmpty() )
        {
            cause = result.getExceptions().get( 0 );
        }
        return cause;
    }

}