View Javadoc
1   package org.apache.maven.settings.building;
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   * Describes a problem that was encountered during settings building. A problem can either be an exception that was
24   * thrown or a simple string message. In addition, a problem carries a hint about its source, e.g. the settings file
25   * that exhibits the problem.
26   *
27   * @author Benjamin Bentmann
28   */
29  public class DefaultSettingsProblem
30      implements SettingsProblem
31  {
32  
33      private final String source;
34  
35      private final int lineNumber;
36  
37      private final int columnNumber;
38  
39      private final String message;
40  
41      private final Exception exception;
42  
43      private final Severity severity;
44  
45      /**
46       * Creates a new problem with the specified message and exception.
47       *
48       * @param message The message describing the problem, may be {@code null}.
49       * @param severity The severity level of the problem, may be {@code null} to default to
50       *            {@link SettingsProblem.Severity#ERROR}.
51       * @param source A hint about the source of the problem like a file path, may be {@code null}.
52       * @param lineNumber The one-based index of the line containing the problem or {@code -1} if unknown.
53       * @param columnNumber The one-based index of the column containing the problem or {@code -1} if unknown.
54       * @param exception The exception that caused this problem, may be {@code null}.
55       */
56      public DefaultSettingsProblem( String message, Severity severity, String source, int lineNumber, int columnNumber,
57                                     Exception exception )
58      {
59          this.message = message;
60          this.severity = ( severity != null ) ? severity : Severity.ERROR;
61          this.source = ( source != null ) ? source : "";
62          this.lineNumber = lineNumber;
63          this.columnNumber = columnNumber;
64          this.exception = exception;
65      }
66  
67      @Override
68      public String getSource()
69      {
70          return source;
71      }
72  
73      @Override
74      public int getLineNumber()
75      {
76          return lineNumber;
77      }
78  
79      @Override
80      public int getColumnNumber()
81      {
82          return columnNumber;
83      }
84  
85      @Override
86      public String getLocation()
87      {
88          StringBuilder buffer = new StringBuilder( 256 );
89  
90          if ( getSource().length() > 0 )
91          {
92              if ( buffer.length() > 0 )
93              {
94                  buffer.append( ", " );
95              }
96              buffer.append( getSource() );
97          }
98  
99          if ( getLineNumber() > 0 )
100         {
101             if ( buffer.length() > 0 )
102             {
103                 buffer.append( ", " );
104             }
105             buffer.append( "line " ).append( getLineNumber() );
106         }
107 
108         if ( getColumnNumber() > 0 )
109         {
110             if ( buffer.length() > 0 )
111             {
112                 buffer.append( ", " );
113             }
114             buffer.append( "column " ).append( getColumnNumber() );
115         }
116 
117         return buffer.toString();
118     }
119 
120     @Override
121     public Exception getException()
122     {
123         return exception;
124     }
125 
126     @Override
127     public String getMessage()
128     {
129         String msg;
130 
131         if ( message != null && message.length() > 0 )
132         {
133             msg = message;
134         }
135         else
136         {
137             msg = exception.getMessage();
138 
139             if ( msg == null )
140             {
141                 msg = "";
142             }
143         }
144 
145         return msg;
146     }
147 
148     @Override
149     public Severity getSeverity()
150     {
151         return severity;
152     }
153 
154     @Override
155     public String toString()
156     {
157         StringBuilder buffer = new StringBuilder( 128 );
158 
159         buffer.append( "[" ).append( getSeverity() ).append( "] " );
160         buffer.append( getMessage() );
161         buffer.append( " @ " ).append( getLocation() );
162 
163         return buffer.toString();
164     }
165 
166 }