View Javadoc

1   package org.apache.maven.usability;
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  import org.apache.maven.artifact.InvalidArtifactRTException;
23  import org.apache.maven.usability.diagnostics.ErrorDiagnoser;
24  
25  public class InvalidArtifactDiagnoser
26      implements ErrorDiagnoser
27  {
28  
29      public boolean canDiagnose( Throwable error )
30      {
31          return error instanceof InvalidArtifactRTException;
32      }
33  
34      public String diagnose( Throwable error )
35      {
36          StringBuffer diagnosis = new StringBuffer();
37  
38          InvalidArtifactRTException e = (InvalidArtifactRTException) error;
39  
40          diagnosis.append( "An invalid artifact was detected.\n\n" )
41              .append( "This artifact might be in your project's POM, " )
42              .append( "or it might have been included transitively during the resolution process. " )
43              .append( "Here is the information we do have for this artifact:\n" )
44              .append( "\n    o GroupID:     " ).append( maybeFlag( e.getGroupId() ) )
45              .append( "\n    o ArtifactID:  " ).append( maybeFlag( e.getArtifactId() ) )
46              .append( "\n    o Version:     " ).append( maybeFlag( e.getVersion() ) )
47              .append( "\n    o Type:        " ).append( maybeFlag( e.getType() ) )
48              .append( "\n" );
49  
50          return diagnosis.toString();
51      }
52  
53      private String maybeFlag( String value )
54      {
55          if ( value == null || value.trim().length() < 1 )
56          {
57              return "<<< MISSING >>>";
58          }
59          else
60          {
61              return value;
62          }
63      }
64  
65  }