com.opensymphony.xwork2.util.location.Location Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.opensymphony.xwork2.util.location;
import java.util.List;
/**
* A location in a resource. The location is composed of the URI of the resource, and
* the line and column numbers within that resource (when available), along with a description.
*
* Locations are mostly provided by {@link Locatable}s objects.
*/
public interface Location {
/**
* Constant for unknown locations.
*/
public static final Location UNKNOWN = LocationImpl.UNKNOWN;
/**
* Get the description of this location
*
* @return the description (can be null)
*/
String getDescription();
/**
* Get the URI of this location
*
* @return the URI (null if unknown).
*/
String getURI();
/**
* Get the line number of this location
*
* @return the line number (-1 if unknown)
*/
int getLineNumber();
/**
* Get the column number of this location
*
* @return the column number (-1 if unknown)
*/
int getColumnNumber();
/**
* Gets a source code snippet with the default padding
*
* @param padding The amount of lines before and after the error to include
* @return A list of source lines
*/
List getSnippet(int padding);
}