This is an automated email from the ASF dual-hosted git repository. juanpablo pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/jspwiki.git
commit 6f0d7768e22e0a88326351a066514f24f13edf1e Author: juanpablo <[email protected]> AuthorDate: Wed Dec 27 23:22:49 2017 +0100 added format --- .../java/org/apache/wiki/url/URLConstructor.java | 66 +++++++++------------- 1 file changed, 26 insertions(+), 40 deletions(-) diff --git a/jspwiki-war/src/main/java/org/apache/wiki/url/URLConstructor.java b/jspwiki-war/src/main/java/org/apache/wiki/url/URLConstructor.java index c516aa8..1f1cf0f 100644 --- a/jspwiki-war/src/main/java/org/apache/wiki/url/URLConstructor.java +++ b/jspwiki-war/src/main/java/org/apache/wiki/url/URLConstructor.java @@ -1,4 +1,4 @@ -/* +/* 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 @@ -14,7 +14,7 @@ "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. + under the License. */ package org.apache.wiki.url; @@ -24,71 +24,57 @@ import javax.servlet.http.HttpServletRequest; import org.apache.wiki.WikiEngine; + /** * Provides an interface through which JSPWiki constructs URLs. * JSPWiki calls the methods of this interface whenever an URL * that points to any JSPWiki internals is required. For example, * if you need to find an URL to the editor page for page "TextFormattingRules", * you would call makeURL( WikiContext.EDIT, "TextFormattingRules", false, null ); - * + * * @since 2.2 */ -public interface URLConstructor -{ +public interface URLConstructor { /** - * Initializes. Note that the engine is not fully initialized - * at this point, so don't do anything fancy here - use lazy - * init, if you have to. - * + * Initializes. Note that the engine is not fully initialized at this + * point, so don't do anything fancy here - use lazy init, if you have to. + * * @param engine The WikiEngine that this URLConstructor belongs to * @param properties Properties used to initialize */ - void initialize( WikiEngine engine, - Properties properties ); + void initialize( WikiEngine engine, Properties properties ); /** * Constructs the URL with a bunch of parameters. - * + * * @param context The request context (@see WikiContext) that you want the URL for - * @param name The page name (or in case of WikiContext.NONE, the auxiliary JSP page - * or resource you want to point at. This must be URL encoded. Null is NOT safe. - * @param absolute True, if you need an absolute URL. False, if both relative and absolute - * URLs are fine. + * @param name The page name (or in case of WikiContext.NONE, the auxiliary JSP page + * or resource you want to point at). This must be URL encoded. Null is NOT safe. + * @param absolute True, if you need an absolute URL. False, if both relative and absolute URLs are fine. * @param parameters An URL parameter string (these must be URL-encoded, and separated with &amp;) - * @return An URL pointing to the resource. Must never return null - throw an InternalWikiException - * if something goes wrong. + * @return An URL pointing to the resource. Must never return null - throw an InternalWikiException if something goes wrong. */ - String makeURL( String context, - String name, - boolean absolute, - String parameters ); + String makeURL( String context, String name, boolean absolute, String parameters ); /** - * Should parse the "page" parameter from the actual - * request. This is essentially the reverse of makeURL() - whenever a request - * constructed by calls to makeURL() is passed to this routine, it MUST be - * able to parse the resource name (WikiPage, Attachment, other resource) from - * the request. - * - * @param context In which request context the request was made (this should - * help in parsing) + * Should parse the "page" parameter from the actual request. This is essentially the reverse of makeURL() - whenever + * a request constructed by calls to makeURL() is passed to this routine, it MUST be able to parse the resource name + * (WikiPage, Attachment, other resource) from the request. + * + * @param context In which request context the request was made (this should help in parsing) * @param request The HTTP request that was used when coming here * @param encoding The encoding with which the request was made (UTF-8 or ISO-8859-1). * @return This method must return the name of the resource. * @throws IOException If parsing failes */ - String parsePage( String context, - HttpServletRequest request, - String encoding ) - throws IOException; - + String parsePage( String context, HttpServletRequest request, String encoding ) throws IOException; + /** - * Returns information which JSP page should continue handling - * this type of request. - * + * Returns information which JSP page should continue handling this type of request. + * * @param request The HTTP Request that was used to end up in this page. - * @return "Wiki.jsp", "PageInfo.jsp", etc. Just return the name, - * JSPWiki will figure out the page. + * @return "Wiki.jsp", "PageInfo.jsp", etc. Just return the name, JSPWiki will figure out the page. */ String getForwardPage( HttpServletRequest request ); + } -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
