package org.apache.maven.wagon.events;

/*
 * 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.wagon.Wagon;
import org.apache.maven.wagon.resource.Resource;

import java.io.File;

TransferEvent is used to notify TransferListeners about progress
in transfer of resources form/to the repository
Author:
Michal Maczka/**
 * TransferEvent is used to notify TransferListeners about progress
 * in transfer of resources form/to the repository
 *
 * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
 *
 */
public class TransferEvent
    extends WagonEvent
{

    
A transfer was attempted, but has not yet commenced.
/**
     * A transfer was attempted, but has not yet commenced.
     */
    public static final int TRANSFER_INITIATED = 0;

    
A transfer was started.
/**
     * A transfer was started.
     */
    public static final int TRANSFER_STARTED = 1;

    
A transfer is completed.
/**
     * A transfer is completed.
     */
    public static final int TRANSFER_COMPLETED = 2;

    
A transfer is in progress.
/**
     * A transfer is in progress.
     */
    public static final int TRANSFER_PROGRESS = 3;

    
An error occurred during transfer
/**
     * An error occurred during transfer
     */
    public static final int TRANSFER_ERROR = 4;

    
Indicates GET transfer  (from the repository)
/**
     * Indicates GET transfer  (from the repository)
     */
    public static final int REQUEST_GET = 5;

    
Indicates PUT transfer (to the repository)
/**
     * Indicates PUT transfer (to the repository)
     */
    public static final int REQUEST_PUT = 6;

    private Resource resource;

    private int eventType;

    private int requestType;

    private Exception exception;

    private File localFile;

    public TransferEvent( final Wagon wagon, final Resource resource, final int eventType, final int requestType )
    {
        super( wagon );

        this.resource = resource;

        setEventType( eventType );

        setRequestType( requestType );

    }

    public TransferEvent( final Wagon wagon, final Resource resource, final Exception exception, final int requestType )
    {
        this( wagon, resource, TRANSFER_ERROR, requestType );

        this.exception = exception;
    }

    
Returns:
Returns the resource./**
     * @return Returns the resource.
     */
    public Resource getResource()
    {
        return resource;
    }

    
Returns:
Returns the exception./**
     * @return Returns the exception.
     */
    public Exception getException()
    {
        return exception;
    }

    
Returns the request type.
Returns:
Returns the request type. The Request type is one of
        TransferEvent.REQUEST_GET or TransferEvent.REQUEST_PUT/**
     * Returns the request type.
     *
     * @return Returns the request type. The Request type is one of
     *         <code>TransferEvent.REQUEST_GET<code> or <code>TransferEvent.REQUEST_PUT<code>
     */
    public int getRequestType()
    {
        return requestType;
    }

    
Sets the request type
Params:
requestType – The requestType to set.
                   The Request type value should be either
                   TransferEvent.REQUEST_GET or TransferEvent.REQUEST_PUT.
Throws:
IllegalArgumentException – when/**
     * Sets the request type
     *
     * @param requestType The requestType to set.
     *                    The Request type value should be either
     *                    <code>TransferEvent.REQUEST_GET<code> or <code>TransferEvent.REQUEST_PUT<code>.
     * @throws IllegalArgumentException when
     */
    public void setRequestType( final int requestType )
    {
        switch ( requestType )
        {

            case REQUEST_PUT:
            case REQUEST_GET:
                break;

            default :
                throw new IllegalArgumentException( "Illegal request type: " + requestType );
        }

        this.requestType = requestType;
    }

    
Returns:
Returns the eventType./**
     * @return Returns the eventType.
     */
    public int getEventType()
    {
        return eventType;
    }

    
Params:
eventType – The eventType to set./**
     * @param eventType The eventType to set.
     */
    public void setEventType( final int eventType )
    {
        switch ( eventType )
        {

            case TRANSFER_INITIATED:
            case TRANSFER_STARTED:
            case TRANSFER_COMPLETED:
            case TRANSFER_PROGRESS:
            case TRANSFER_ERROR:
                break;
            default :
                throw new IllegalArgumentException( "Illegal event type: " + eventType );
        }

        this.eventType = eventType;
    }

    
Params:
resource – The resource to set./**
     * @param resource The resource to set.
     */
    public void setResource( final Resource resource )
    {
        this.resource = resource;
    }

    
Returns:
Returns the local file./**
     * @return Returns the local file.
     */
    public File getLocalFile()
    {
        return localFile;
    }

    
Params:
localFile – The local file to set./**
     * @param localFile The local file to set.
     */
    public void setLocalFile( File localFile )
    {
        this.localFile = localFile;
    }

    public String toString()
    {
        StringBuilder sb = new StringBuilder();

        sb.append( "TransferEvent[" );

        switch ( this.getRequestType() )
        {
            case REQUEST_GET:
                sb.append( "GET" );
                break;
            case REQUEST_PUT:
                sb.append( "PUT" );
                break;
            default:
                sb.append( this.getRequestType() );
                break;
        }

        sb.append( "|" );
        switch ( this.getEventType() )
        {
            case TRANSFER_COMPLETED:
                sb.append( "COMPLETED" );
                break;
            case TRANSFER_ERROR:
                sb.append( "ERROR" );
                break;
            case TRANSFER_INITIATED:
                sb.append( "INITIATED" );
                break;
            case TRANSFER_PROGRESS:
                sb.append( "PROGRESS" );
                break;
            case TRANSFER_STARTED:
                sb.append( "STARTED" );
                break;
            default:
                sb.append( this.getEventType() );
                break;
        }

        sb.append( "|" );

        sb.append( this.getWagon().getRepository() ).append( "|" );
        sb.append( this.getLocalFile() ).append( "|" );
        sb.append( this.getResource().inspect() );
        sb.append( "]" );

        return sb.toString();
    }

    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + eventType;
        result = prime * result + ( ( exception == null ) ? 0 : exception.hashCode() );
        result = prime * result + ( ( localFile == null ) ? 0 : localFile.hashCode() );
        result = prime * result + requestType;
        result = prime * result + ( ( resource == null ) ? 0 : resource.hashCode() );
        return result;
    }

    public boolean equals( Object obj )
    {
        if ( this == obj )
        {
            return true;
        }
        if ( ( obj == null ) || ( getClass() != obj.getClass() ) )
        {
            return false;
        }
        final TransferEvent other = (TransferEvent) obj;
        if ( eventType != other.eventType )
        {
            return false;
        }
        if ( exception == null )
        {
            if ( other.exception != null )
            {
                return false;
            }
        }
        else if ( !exception.getClass().equals( other.exception.getClass() ) )
        {
            return false;
        }
        if ( requestType != other.requestType )
        {
            return false;
        }
        if ( resource == null )
        {
            if ( other.resource != null )
            {
                return false;
            }
        }
        else if ( !resource.equals( other.resource ) )
        {
            return false;
        }
        else if ( !source.equals( other.source ) )
        {
            return false;
        }
        return true;
    }
    
}