Prefix.java revision d8371503c60e1f6933455e25b1cc47e4858a3a43
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* See LICENSE.txt included in this distribution for the specific
* language governing permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at LICENSE.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright (c) 2011 Jens Elkner.
*/
/**
* URL Prefixes usually tied to a certain servlet.
*
* @author Jens Elkner
* @version $Revision$
*/
public enum Prefix {
/** unknown prefix */
UNKNOWN(""),
/** a cross reference */
XREF_P("/xref"),
/** a show cross reference, i.e. add Line and Navigation toggle button in
* the menu bar */
XREF_S("/xr"),
/** show more lines. If a search result set for a file matches more lines
* than a given limit (default: 10), only the first <i>limit</i> lines gets
* shown as an "[all ...]" link, which can be used to show all matching
* lines. The servlet path of this link starts with this prefix. */
MORE_P("/more"),
/** reserved (not used) */
MORE_S("/mo"),
/** diff to previous version (link prefix) */
DIFF_P("/diff"),
/** reserved (not used) */
DIFF_S("/di"),
/** reserved (not used) */
HIST_P("/hist"),
/** reserved (not used) */
HIST_S("/hi"),
/** show the history for a file (link prefix) */
HIST_L("/history"),
/** RSS XML Feed of latest changes (link prefix) */
RSS_P("/rss"),
/** Download file (link prefix) */
DOWNLOAD_P("/download"),
/** Raw file display (link prefix) */
RAW_P("/raw"),
/** full blown search from main page or top bar (link prefix) */
SEARCH_P("/search"),
/** search from cross reference, can lead to direct match (which opens
* directly) or to a matches Summary page */
SEARCH_R("/s"),
/** opensearch description page */
SEARCH_O("/opensearch"),
/** related source file or directory not found/unavailable/ignored */
NOT_FOUND("/enoent"),
/** misc error occurred */
ERROR("/error")
;
}
/**
* Get the string used as prefix.
* @return the prefix
*/
return prefix;
}
// should be sufficient for now
static {
}
}
/**
* Get the prefix of the given path.
* @param servletPath path to check
* @return {@link Prefix#UNKNOWN} if <var>path</var> is {@code null} or has
* no or unknown prefix, the corresponding prefix otherwise.
* @see #toString()
*/
{
return UNKNOWN;
}
}
}