001    package org.apache.maven.lifecycle;
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    
022    /**
023     * Signals a failure to locate the lifecycle for some phase.
024     * 
025     * @author Benjamin Bentmann
026     */
027    public class LifecyclePhaseNotFoundException
028        extends Exception
029    {
030    
031        private final String lifecyclePhase;
032    
033        /**
034         * Creates a new exception to indicate that the specified lifecycle phase is not defined by any known lifecycle.
035         * 
036         * @param message The detail message, may be {@code null}.
037         * @param lifecyclePhase The name of the lifecycle phase that could not be located, may be {@code null}.
038         */
039        public LifecyclePhaseNotFoundException( String message, String lifecyclePhase )
040        {
041            super( message );
042            this.lifecyclePhase = ( lifecyclePhase != null ) ? lifecyclePhase : "";
043        }
044    
045        /**
046         * Gets the lifecycle phase that was not found.
047         * 
048         * @return The lifecycle phase that was not found, never {@code null}.
049         */
050        public String getLifecyclePhase()
051        {
052            return lifecyclePhase;
053        }
054    
055    }