001    /*
002     * Copyright 2004-2005 Stephen J. McConnell.
003     *
004     * Licensed  under the  Apache License,  Version 2.0  (the "License");
005     * you may not use  this file  except in  compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *   http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed  under the  License is distributed on an "AS IS" BASIS,
012     * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
013     * implied.
014     *
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package net.dpml.transit;
020    
021    /**
022     * Exception to indicate that the Artifact already exists in the cache and
023     * can therefor not be written to.
024     *
025     * @author <a href="http://www.dpml.net">Digital Product Management Library</a>
026     * @version 2.1.1
027     */
028    public class ArtifactAlreadyExistsException extends ArtifactException
029    {
030       /**
031        * Serial version identifier.
032        */
033        static final long serialVersionUID = 1L;
034    
035        // ------------------------------------------------------------------------
036        // state
037        // ------------------------------------------------------------------------
038    
039       /**
040        * The artifact that we tried to write to.
041        */
042        private final Artifact m_artifact;
043    
044        // ------------------------------------------------------------------------
045        // constructor
046        // ------------------------------------------------------------------------
047    
048        /**
049         * Construct a new <code>ArtifactAlreadyExistsException</code> instance.
050         *
051         * @param message the exception message
052         * @param artifact the subject artifact
053         */
054        public ArtifactAlreadyExistsException( final String message, final Artifact artifact )
055        {
056            super( message );
057            m_artifact = artifact;
058        }
059    
060        /**
061         * Returns the Artifact that were attempted to be written to.
062         * @return the subject artifact
063         */
064        public Artifact getArtifact()
065        {
066            return m_artifact;
067        }
068    }
069