1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.jci.problems;
19
20 /**
21 * An abstract definition of a compilation problem
22 *
23 * @author tcurdt
24 */
25 public interface CompilationProblem {
26
27 /**
28 * is the problem an error and compilation cannot continue
29 * or just a warning and compilation can proceed
30 *
31 * @return true if the problem is an error
32 */
33 boolean isError();
34
35 /**
36 * name of the file where the problem occurred
37 *
38 * @return name of the file where the problem occurred
39 */
40 String getFileName();
41
42 /**
43 * position of where the problem starts in the source code
44 *
45 * @return position of where the problem starts in the source code
46 */
47 int getStartLine();
48 int getStartColumn();
49
50 /**
51 * position of where the problem stops in the source code
52 *
53 * @return position of where the problem stops in the source code
54 */
55 int getEndLine();
56 int getEndColumn();
57
58 /**
59 * the description of the problem
60 *
61 * @return the description of the problem
62 */
63 String getMessage();
64
65 }