001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018 package org.apache.commons.jci.problems;
019
020 /**
021 * An abstract definition of a compilation problem
022 *
023 * @author tcurdt
024 */
025 public interface CompilationProblem {
026
027 /**
028 * is the problem an error and compilation cannot continue
029 * or just a warning and compilation can proceed
030 *
031 * @return true if the problem is an error
032 */
033 boolean isError();
034
035 /**
036 * name of the file where the problem occurred
037 *
038 * @return name of the file where the problem occurred
039 */
040 String getFileName();
041
042 /**
043 * position of where the problem starts in the source code
044 *
045 * @return position of where the problem starts in the source code
046 */
047 int getStartLine();
048 int getStartColumn();
049
050 /**
051 * position of where the problem stops in the source code
052 *
053 * @return position of where the problem stops in the source code
054 */
055 int getEndLine();
056 int getEndColumn();
057
058 /**
059 * the description of the problem
060 *
061 * @return the description of the problem
062 */
063 String getMessage();
064
065 }