Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id B1EF5200C46 for ; Wed, 29 Mar 2017 21:56:13 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id B035F160B5D; Wed, 29 Mar 2017 19:56:13 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id C6AF2160BC1 for ; Wed, 29 Mar 2017 21:56:08 +0200 (CEST) Received: (qmail 55521 invoked by uid 500); 29 Mar 2017 19:56:08 -0000 Mailing-List: contact commits-help@jspwiki.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jspwiki.apache.org Delivered-To: mailing list commits@jspwiki.apache.org Received: (qmail 55108 invoked by uid 99); 29 Mar 2017 19:56:06 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 29 Mar 2017 19:56:06 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id BA144E0061; Wed, 29 Mar 2017 19:56:06 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: git-site-role@apache.org To: commits@jspwiki.apache.org Date: Wed, 29 Mar 2017 19:56:45 -0000 Message-Id: <22a980a3cbc64806a089f24869a5db9f@git.apache.org> In-Reply-To: <5950f91d6989465eadac40c6555987eb@git.apache.org> References: <5950f91d6989465eadac40c6555987eb@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [41/51] [partial] jspwiki-site git commit: Automatic Site Publish by Buildbot archived-at: Wed, 29 Mar 2017 19:56:14 -0000 http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/d8c50ef6/content/apidocs/2.10.1/org/apache/wiki/Release.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/Release.html b/content/apidocs/2.10.1/org/apache/wiki/Release.html deleted file mode 100755 index 1af803e..0000000 --- a/content/apidocs/2.10.1/org/apache/wiki/Release.html +++ /dev/null @@ -1,478 +0,0 @@ - - - - - - - -Release (Apache JSPWiki Main War 2.10.1 API) - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -org.apache.wiki -
-Class Release

-
-java.lang.Object
-  extended by org.apache.wiki.Release
-
-
-
-
public final class Release
extends Object
- - - - -
- -

-Contains release and version information. You may also invoke this class directly, in which case it prints - out the version string. This is a handy way of checking which JSPWiki version you have - just type - from a command line: - 

-  % java -cp JSPWiki.jar org.apache.wiki.Release
-  2.5.38
-
-

- As a historical curiosity, this is the oldest JSPWiki file. According to the CVS history, it dates from 6.7.2001, - and it really hasn't changed much since. -

-

- -

-

-
Since:
-
1.0
-
-
- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Field Summary
-static StringAPPNAME - -
-          This is the default application name.
-static StringBUILD - -
-          The build number/identifier.
-static intMINORREVISION - -
-          The minor revision.
-static intREVISION - -
-          The JSPWiki revision.
-static intVERSION - -
-          The JSPWiki major version.
-static StringVERSTR - -
-          This is the generic version string you should use when printing out the version.
-  - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
-static StringgetVersionString() - -
-          This method is useful for templates, because hopefully it will - not be inlined, and thus any change to version number does not - need recompiling the pages.
-static booleanisNewerOrEqual(String version) - -
-          Returns true, if this version of JSPWiki is newer or equal than what is requested.
-static booleanisOlderOrEqual(String version) - -
-          Returns true, if this version of JSPWiki is older or equal than what is requested.
-static voidmain(String[] argv) - -
-          Executing this class directly from command line prints out the current version.
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Field Detail
- -

-APPNAME

-
-public static final String APPNAME
-
-
This is the default application name. -

-

-
See Also:
Constant Field Values
-
-
- -

-VERSION

-
-public static final int VERSION
-
-
The JSPWiki major version. -

-

-
See Also:
Constant Field Values
-
-
- -

-REVISION

-
-public static final int REVISION
-
-
The JSPWiki revision. -

-

-
See Also:
Constant Field Values
-
-
- -

-MINORREVISION

-
-public static final int MINORREVISION
-
-
The minor revision. -

-

-
See Also:
Constant Field Values
-
-
- -

-BUILD

-
-public static final String BUILD
-
-
The build number/identifier. This is a String as opposed to an integer, just so that people can add - other identifiers to it. The build number is incremented every time a committer checks in code, and reset - when the a release is made. -

- If you are a person who likes to build his own releases, we recommend that you add your initials to this - identifier (e.g. "13-jj", or 49-aj"). -

- If the build identifier is empty, it is not added. -

-

-
See Also:
Constant Field Values
-
-
- -

-VERSTR

-
-public static final String VERSTR
-
-
This is the generic version string you should use when printing out the version. It is of - the form "VERSION.REVISION.MINORREVISION[-POSTFIX][-BUILD]". -

-

-
-
- - - - - - - - -
-Method Detail
- -

-getVersionString

-
-public static String getVersionString()
-
-
This method is useful for templates, because hopefully it will - not be inlined, and thus any change to version number does not - need recompiling the pages. -

-

- -
Returns:
The version string (e.g. 2.5.23).
Since:
-
2.1.26.
-
-
-
-
- -

-isNewerOrEqual

-
-public static boolean isNewerOrEqual(String version)
-                              throws IllegalArgumentException
-
-
Returns true, if this version of JSPWiki is newer or equal than what is requested. -

-

-
Parameters:
version - A version parameter string (a.b.c-something). B and C are optional. -
Returns:
A boolean value describing whether the given version is newer than the current JSPWiki. -
Throws: -
IllegalArgumentException - If the version string could not be parsed.
Since:
-
2.4.57
-
-
-
-
- -

-isOlderOrEqual

-
-public static boolean isOlderOrEqual(String version)
-                              throws IllegalArgumentException
-
-
Returns true, if this version of JSPWiki is older or equal than what is requested. -

-

-
Parameters:
version - A version parameter string (a.b.c-something) -
Returns:
A boolean value describing whether the given version is older than the current JSPWiki version -
Throws: -
IllegalArgumentException - If the version string could not be parsed.
Since:
-
2.4.57
-
-
-
-
- -

-main

-
-public static void main(String[] argv)
-
-
Executing this class directly from command line prints out the current version. It is very useful for - things like different command line tools. -

Example: - 

-  % java org.apache.wiki.Release
-  1.9.26-cvs
-
-

-

-
Parameters:
argv - The argument string. This class takes in no arguments.
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
-Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. - - http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/d8c50ef6/content/apidocs/2.10.1/org/apache/wiki/Release.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/Release.png b/content/apidocs/2.10.1/org/apache/wiki/Release.png deleted file mode 100755 index 21edf2b..0000000 Binary files a/content/apidocs/2.10.1/org/apache/wiki/Release.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/d8c50ef6/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.html b/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.html deleted file mode 100755 index dbcdae1..0000000 --- a/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - - -StringTransmutator (Apache JSPWiki Main War 2.10.1 API) - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -org.apache.wiki -
-Interface StringTransmutator

-
-
All Known Implementing Classes:
LinkCollector
-
-
-
-
public interface StringTransmutator
- - - - - -
- -

-Defines an interface for transforming strings within a Wiki context. -

- -

-

-
Since:
-
1.6.4
-
-
- -

- - - - - - - - - - - - -
-Method Summary
- Stringmutate(WikiContext context, - String source) - -
-          Returns a changed String, suitable for Wiki context.
-  -

- - - - - - - - -
-Method Detail
- -

-mutate

-
-String mutate(WikiContext context,
-              String source)
-
-
Returns a changed String, suitable for Wiki context. -

-

-
Parameters:
context - WikiContext in which mutation is to be done
source - The source string. -
Returns:
The mutated string.
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
-Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. - - http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/d8c50ef6/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.png b/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.png deleted file mode 100755 index 8e0dfbd..0000000 Binary files a/content/apidocs/2.10.1/org/apache/wiki/StringTransmutator.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/d8c50ef6/content/apidocs/2.10.1/org/apache/wiki/VariableManager.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/VariableManager.html b/content/apidocs/2.10.1/org/apache/wiki/VariableManager.html deleted file mode 100755 index a6cb66a..0000000 --- a/content/apidocs/2.10.1/org/apache/wiki/VariableManager.html +++ /dev/null @@ -1,463 +0,0 @@ - - - - - - - -VariableManager (Apache JSPWiki Main War 2.10.1 API) - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -org.apache.wiki -
-Class VariableManager

-
-java.lang.Object
-  extended by org.apache.wiki.VariableManager
-
-
-
-
public class VariableManager
extends Object
- - - - -
- -

-Manages variables. Variables are case-insensitive. A list of all - available variables is on a Wiki page called "WikiVariables". -

- -

-

-
Since:
-
1.9.20.
-
-
- -

- - - - - - - - - - - - - - - -
-Field Summary
-static StringVAR_ERROR - -
-           
-static StringVAR_MSG - -
-           
-  - - - - - - - - - - -
-Constructor Summary
VariableManager(Properties props) - -
-          Creates a VariableManager object using the property list given.
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- StringexpandVariables(WikiContext context, - String source) - -
-          This method does in-place expansion of any variables.
- StringgetValue(WikiContext context, - String varName) - -
-          Returns a value of the named variable.
- StringgetValue(WikiContext context, - String varName, - String defValue) - -
-          Returns the value of a named variable.
-static booleanisVariableLink(String link) - -
-          Returns true if the link is really command to insert - a variable.
- StringparseAndGetValue(WikiContext context, - String link) - -
-          Parses the link and finds a value.
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Field Detail
- -

-VAR_ERROR

-
-public static final String VAR_ERROR
-
-
-
See Also:
Constant Field Values
-
-
- -

-VAR_MSG

-
-public static final String VAR_MSG
-
-
-
See Also:
Constant Field Values
-
- - - - - - - - -
-Constructor Detail
- -

-VariableManager

-
-public VariableManager(Properties props)
-
-
Creates a VariableManager object using the property list given. -

-

-
Parameters:
props - The properties.
-
- - - - - - - - -
-Method Detail
- -

-isVariableLink

-
-public static boolean isVariableLink(String link)
-
-
Returns true if the link is really command to insert - a variable. -

- Currently we just check if the link starts with "{$". -

-

-
Parameters:
link - The link text -
Returns:
true, if this represents a variable link.
-
-
-
- -

-parseAndGetValue

-
-public String parseAndGetValue(WikiContext context,
-                               String link)
-                        throws IllegalArgumentException,
-                               NoSuchVariableException
-
-
Parses the link and finds a value. This is essentially used - once isVariableLink(String) has found that the link text - actually contains a variable. For example, you could pass in - "{$username}" and get back "JanneJalkanen". -

-

-
Parameters:
context - The WikiContext
link - The link text containing the variable name. -
Returns:
The variable value. -
Throws: -
IllegalArgumentException - If the format is not valid (does not - start with "{$", is zero length, etc.) -
NoSuchVariableException - If a variable is not known.
-
-
-
- -

-expandVariables

-
-public String expandVariables(WikiContext context,
-                              String source)
-
-
This method does in-place expansion of any variables. However, - the expansion is not done twice, that is, a variable containing text $variable - will not be expanded. -

- The variables should be in the same format ({$variablename} as in the web - pages. -

-

-
Parameters:
context - The WikiContext of the current page.
source - The source string. -
Returns:
The source string with variables expanded.
-
-
-
- -

-getValue

-
-public String getValue(WikiContext context,
-                       String varName,
-                       String defValue)
-
-
Returns the value of a named variable. See getValue(WikiContext, String). - The only difference is that this method does not throw an exception, but it - returns the given default value instead. -

-

-
Parameters:
context - WikiContext
varName - The name of the variable
defValue - A default value. -
Returns:
The variable value, or if not found, the default value.
-
-
-
- -

-getValue

-
-public String getValue(WikiContext context,
-                       String varName)
-                throws IllegalArgumentException,
-                       NoSuchVariableException
-
-
Returns a value of the named variable. The resolving order is -
    -
  1. Known "constant" name, such as "pagename", etc. This is so - that pages could not override certain constants. -
  2. WikiContext local variable. This allows a programmer to - set a parameter which cannot be overridden by user. -
  3. HTTP Session -
  4. HTTP Request parameters -
  5. WikiPage variable. As set by the user with the SET directive. -
  6. jspwiki.properties -
- - Use this method only whenever you really need to have a parameter that - can be overridden by anyone using the wiki. -

-

-
Parameters:
context - The WikiContext
varName - Name of the variable. -
Returns:
The variable value. -
Throws: -
IllegalArgumentException - If the name is somehow broken. -
NoSuchVariableException - If a variable is not known.
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
-Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. - - http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/d8c50ef6/content/apidocs/2.10.1/org/apache/wiki/VariableManager.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/VariableManager.png b/content/apidocs/2.10.1/org/apache/wiki/VariableManager.png deleted file mode 100755 index 318a9ec..0000000 Binary files a/content/apidocs/2.10.1/org/apache/wiki/VariableManager.png and /dev/null differ