001package org.apache.maven.wagon.events;
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.util.EventObject;
023
024import org.apache.maven.wagon.Wagon;
025
026/**
027 * Base class for all events emitted by <code>Wagon</code> objects.
028 *
029 * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
030 *
031 */
032public class WagonEvent
033    extends EventObject
034{
035    /**
036     * The time when event occurred
037     */
038    protected long timestamp;
039
040    /**
041     * @param source The Wagon object on which the WagonEvent initially occurred
042     */
043    public WagonEvent( final Wagon source )
044    {
045        super( source );
046    }
047
048    /**
049     * Returns The Wagon object on which the WagonEvent initially occurred
050     *
051     * @return The Wagon object on which the WagonEvent initially occurred
052     */
053    public Wagon getWagon()
054    {
055        return (Wagon) getSource();
056    }
057
058    /**
059     * Returns the timestamp which indicated the time when this event has occurred
060     *
061     * @return Returns the timestamp.
062     */
063    public long getTimestamp()
064    {
065        return timestamp;
066    }
067
068    /**
069     * Sets the timestamp which indicated the time when this event has occurred
070     *
071     * @param timestamp The timestamp to set.
072     */
073    public void setTimestamp( final long timestamp )
074    {
075        this.timestamp = timestamp;
076    }
077
078}