Struts example source code file (Location.java)

This example Struts source code file (Location.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Struts tags/keywords

list, list, location, location, string, string, unknown, unknown, util

The Struts Location.java source code

/*
 * Copyright 2005 The Apache Software Foundation.
 * 
 * Licensed 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.
 * <p>
 * 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 <code>null)
     */
    String getDescription();
    
    /**
     * Get the URI of this location
     * 
     * @return the URI (<code>null if unknown).
     */
    String getURI();

    /**
     * Get the line number of this location
     * 
     * @return the line number (<code>-1 if unknown)
     */
    int getLineNumber();
    
    /**
     * Get the column number of this location
     * 
     * @return the column number (<code>-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<String> getSnippet(int padding);
}