View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.lifecycle;
20  
21  /**
22   * Signals a failure to locate the lifecycle for some phase.
23   *
24   * @author Benjamin Bentmann
25   */
26  public class LifecyclePhaseNotFoundException extends Exception {
27  
28      private final String lifecyclePhase;
29  
30      /**
31       * Creates a new exception to indicate that the specified lifecycle phase is not defined by any known lifecycle.
32       *
33       * @param message The detail message, may be {@code null}.
34       * @param lifecyclePhase The name of the lifecycle phase that could not be located, may be {@code null}.
35       */
36      public LifecyclePhaseNotFoundException(String message, String lifecyclePhase) {
37          super(message);
38          this.lifecyclePhase = (lifecyclePhase != null) ? lifecyclePhase : "";
39      }
40  
41      /**
42       * Gets the lifecycle phase that was not found.
43       *
44       * @return The lifecycle phase that was not found, never {@code null}.
45       */
46      public String getLifecyclePhase() {
47          return lifecyclePhase;
48      }
49  }