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