Return-Path: X-Original-To: apmail-incubator-rat-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-rat-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 2709C9672 for ; Sun, 15 Apr 2012 10:17:00 +0000 (UTC) Received: (qmail 6049 invoked by uid 500); 15 Apr 2012 10:17:00 -0000 Delivered-To: apmail-incubator-rat-commits-archive@incubator.apache.org Received: (qmail 6028 invoked by uid 500); 15 Apr 2012 10:17:00 -0000 Mailing-List: contact rat-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: rat-dev@incubator.apache.org Delivered-To: mailing list rat-commits@incubator.apache.org Received: (qmail 6021 invoked by uid 99); 15 Apr 2012 10:17:00 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 15 Apr 2012 10:17:00 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 15 Apr 2012 10:16:46 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 2BACE2388B6C; Sun, 15 Apr 2012 10:16:23 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1326295 [5/8] - in /incubator/rat/site/trunk/content/rat/whisker: apache-whisker-cli/apidocs/org/apache/creadur/ apache-whisker-cli/apidocs/org/apache/creadur/whisker/ apache-whisker-cli/apidocs/org/apache/creadur/whisker/cli/ apache-whisk... Date: Sun, 15 Apr 2012 10:16:20 -0000 To: rat-commits@incubator.apache.org From: rdonkin@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120415101623.2BACE2388B6C@eris.apache.org> Propchange: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-cli/testapidocs/org/apache/creadur/whisker/cli/package-tree.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-cli/testapidocs/org/apache/creadur/whisker/cli/package-use.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apache-whisker-cli/testapidocs/org/apache/creadur/whisker/cli/package-use.html?rev=1326295&view=auto ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apache-whisker-cli/testapidocs/org/apache/creadur/whisker/cli/package-use.html (added) +++ incubator/rat/site/trunk/content/rat/whisker/apache-whisker-cli/testapidocs/org/apache/creadur/whisker/cli/package-use.html Sun Apr 15 10:16:18 2012 @@ -0,0 +1,143 @@ + + + + + + + +Uses of Package org.apache.creadur.whisker.cli (Apache Whisker::Command Line Interface 0.1-SNAPSHOT Test API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.apache.creadur.whisker.cli

+
+No usage of org.apache.creadur.whisker.cli +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011-2012 Apache Software Foundation. All Rights Reserved. + + Propchange: incubator/rat/site/trunk/content/rat/whisker/apache-whisker-cli/testapidocs/org/apache/creadur/whisker/cli/package-use.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/CommandLineOption.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/CommandLineOption.html?rev=1326295&view=auto ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/CommandLineOption.html (added) +++ incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/CommandLineOption.html Sun Apr 15 10:16:18 2012 @@ -0,0 +1,521 @@ + + + + + + + +CommandLineOption (Apache Whisker 0.1-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.creadur.whisker.cli +
+Enum CommandLineOption

+
+java.lang.Object
+  extended by java.lang.Enum<CommandLineOption>
+      extended by org.apache.creadur.whisker.cli.CommandLineOption
+
+
+
All Implemented Interfaces:
Serializable, Comparable<CommandLineOption>
+
+
+
+
public enum CommandLineOption
extends Enum<CommandLineOption>
+ + +

+Describes an option on the command line. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ACT_TO_AUDIT + +
+          Audit command line argument.
ACT_TO_GENERATE + +
+          Generation command line argument.
LICENSE_DESCRIPTION + +
+          License descriptor command line argument.
SOURCE + +
+          Application source command line argument.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ org.apache.commons.cli.Optioncreate() + +
+          Builds a representation.
+ StringgetDescription() + +
+          Gets the description for this option.
+ StringgetLongName() + +
+          Gets the long name of this command line argument.
+ StringgetOptionValue(org.apache.commons.cli.CommandLine commandLine) + +
+          Gets an option value from the command line.
+ chargetShortName() + +
+          Gets the short name of this command line argument.
+ booleanisSetOn(org.apache.commons.cli.CommandLine commandLine) + +
+          Is the short name option set?
+static org.apache.commons.cli.Optionsoptions() + +
+          Creates options for the command line.
+static CommandLineOptionvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static CommandLineOption[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+LICENSE_DESCRIPTION

+
+public static final CommandLineOption LICENSE_DESCRIPTION
+
+
License descriptor command line argument. +

+

+
+
+
+ +

+SOURCE

+
+public static final CommandLineOption SOURCE
+
+
Application source command line argument. +

+

+
+
+
+ +

+ACT_TO_GENERATE

+
+public static final CommandLineOption ACT_TO_GENERATE
+
+
Generation command line argument. +

+

+
+
+
+ +

+ACT_TO_AUDIT

+
+public static final CommandLineOption ACT_TO_AUDIT
+
+
Audit command line argument. +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static CommandLineOption[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (CommandLineOption c : CommandLineOption.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static CommandLineOption valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+options

+
+public static org.apache.commons.cli.Options options()
+
+
Creates options for the command line. +

+

+ +
Returns:
not null
+
+
+
+ +

+getLongName

+
+public String getLongName()
+
+
Gets the long name of this command line argument. +

+

+ +
Returns:
not null
+
+
+
+ +

+getShortName

+
+public char getShortName()
+
+
Gets the short name of this command line argument. +

+

+ +
Returns:
the character short for this option
+
+
+
+ +

+getDescription

+
+public String getDescription()
+
+
Gets the description for this option. +

+

+ +
Returns:
not null
+
+
+
+ +

+create

+
+public org.apache.commons.cli.Option create()
+
+
Builds a representation. +

+

+ +
Returns:
not null
+
+
+
+ +

+getOptionValue

+
+public String getOptionValue(org.apache.commons.cli.CommandLine commandLine)
+
+
Gets an option value from the command line. +

+

+
Parameters:
commandLine - not null +
Returns:
not null
+
+
+
+ +

+isSetOn

+
+public boolean isSetOn(org.apache.commons.cli.CommandLine commandLine)
+
+
Is the short name option set? +

+

+
Parameters:
commandLine - not null +
Returns:
true when the option is present, false otherwise
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011-2012 Apache Software Foundation. All Rights Reserved. + + Propchange: incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/CommandLineOption.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/Main.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/Main.html?rev=1326295&view=auto ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/Main.html (added) +++ incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/Main.html Sun Apr 15 10:16:18 2012 @@ -0,0 +1,341 @@ + + + + + + + +Main (Apache Whisker 0.1-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.creadur.whisker.cli +
+Class Main

+
+java.lang.Object
+  extended by org.apache.creadur.whisker.cli.Main
+
+
+
+
public final class Main
extends Object
+ + +

+Command line interface for whisker. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Main(Whisker whisker) + +
+          Constructs a wrapper for the given application.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Whiskerconfigure(String[] args) + +
+          Parses arguments and configures the application.
+static voidmain(String[] args) + +
+          Bootstraps application.
+ org.apache.commons.cli.CommandLineparse(String[] args) + +
+          Parses a line of arguments.
+ intrun(String[] args) + +
+          Runs Whisker.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Main

+
+public Main(Whisker whisker)
+
+
Constructs a wrapper for the given application. +

+

+
Parameters:
whisker - not null
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+                 throws Exception
+
+
Bootstraps application. +

+

+
Parameters:
args - not null +
Throws: +
Exception - when application unexpectedly fails
+
+
+
+ +

+parse

+
+public org.apache.commons.cli.CommandLine parse(String[] args)
+                                         throws org.apache.commons.cli.ParseException
+
+
Parses a line of arguments. +

+

+
Parameters:
args - not null +
Returns:
not null +
Throws: +
org.apache.commons.cli.ParseException - when parsing fails
+
+
+
+ +

+configure

+
+public Whisker configure(String[] args)
+                  throws org.apache.commons.cli.ParseException
+
+
Parses arguments and configures the application. +

+

+
Parameters:
args - not null +
Returns:
not null +
Throws: +
org.apache.commons.cli.ParseException - when arguments cannot be parsed
+
+
+
+ +

+run

+
+public int run(String[] args)
+        throws Exception
+
+
Runs Whisker. +

+

+
Parameters:
args - not null +
Returns:
system return code +
Throws: +
Exception - when application unexpectedly fails
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011-2012 Apache Software Foundation. All Rights Reserved. + + Propchange: incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/Main.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/SystemLog.html URL: http://svn.apache.org/viewvc/incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/SystemLog.html?rev=1326295&view=auto ============================================================================== --- incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/SystemLog.html (added) +++ incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/SystemLog.html Sun Apr 15 10:16:18 2012 @@ -0,0 +1,691 @@ + + + + + + + +SystemLog (Apache Whisker 0.1-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.creadur.whisker.cli +
+Class SystemLog

+
+java.lang.Object
+  extended by org.apache.creadur.whisker.cli.SystemLog
+
+
+
All Implemented Interfaces:
org.apache.commons.logging.Log
+
+
+
+
public final class SystemLog
extends Object
implements org.apache.commons.logging.Log
+ + +

+Logs important messages to system err. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
SystemLog() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddebug(Object message) + +
+          Ignored.
+ voiddebug(Object message, + Throwable t) + +
+          Ignored.
+ voiderror(Object message) + +
+          Logs to stderr.
+ voiderror(Object message, + Throwable t) + +
+          Logs to stderr.
+ voidfatal(Object message) + +
+          Logs to stderr.
+ voidfatal(Object message, + Throwable t) + +
+          Logs to stderr.
+ voidinfo(Object message) + +
+          Ignored.
+ voidinfo(Object message, + Throwable t) + +
+          Ignored.
+ booleanisDebugEnabled() + +
+          Disabled.
+ booleanisErrorEnabled() + +
+          Enabled.
+ booleanisFatalEnabled() + +
+          Enabled.
+ booleanisInfoEnabled() + +
+          Disabled.
+ booleanisTraceEnabled() + +
+          Disabled.
+ booleanisWarnEnabled() + +
+          Disabled.
+ voidtrace(Object message) + +
+          Ignored.
+ voidtrace(Object message, + Throwable t) + +
+          Ignored.
+ voidwarn(Object message) + +
+          Ignored.
+ voidwarn(Object message, + Throwable t) + +
+          Ignored.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SystemLog

+
+public SystemLog()
+
+
+ + + + + + + + +
+Method Detail
+ +

+debug

+
+public void debug(Object message)
+
+
Ignored. +

+

+
Specified by:
debug in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
See Also:
Log.debug(java.lang.Object)
+
+
+
+ +

+debug

+
+public void debug(Object message,
+                  Throwable t)
+
+
Ignored. +

+

+
Specified by:
debug in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
t - possibly null
See Also:
Log.debug(java.lang.Object, java.lang.Throwable)
+
+
+
+ +

+error

+
+public void error(Object message)
+
+
Logs to stderr. +

+

+
Specified by:
error in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
See Also:
Log.error(java.lang.Object)
+
+
+
+ +

+error

+
+public void error(Object message,
+                  Throwable t)
+
+
Logs to stderr. +

+

+
Specified by:
error in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
t - possibly null
See Also:
Log.error(java.lang.Object, java.lang.Throwable)
+
+
+
+ +

+fatal

+
+public void fatal(Object message)
+
+
Logs to stderr. +

+

+
Specified by:
fatal in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
See Also:
Log.fatal(java.lang.Object)
+
+
+
+ +

+fatal

+
+public void fatal(Object message,
+                  Throwable t)
+
+
Logs to stderr. +

+

+
Specified by:
fatal in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
t - possibly null
See Also:
Log.fatal(java.lang.Object, java.lang.Throwable)
+
+
+
+ +

+info

+
+public void info(Object message)
+
+
Ignored. +

+

+
Specified by:
info in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
See Also:
Log.info(java.lang.Object)
+
+
+
+ +

+info

+
+public void info(Object message,
+                 Throwable t)
+
+
Ignored. +

+

+
Specified by:
info in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
t - possibly null
See Also:
info(java.lang.Object, java.lang.Throwable)
+
+
+
+ +

+isDebugEnabled

+
+public boolean isDebugEnabled()
+
+
Disabled. +

+

+
Specified by:
isDebugEnabled in interface org.apache.commons.logging.Log
+
+
+ +
Returns:
false
See Also:
Log.isDebugEnabled()
+
+
+
+ +

+isErrorEnabled

+
+public boolean isErrorEnabled()
+
+
Enabled. +

+

+
Specified by:
isErrorEnabled in interface org.apache.commons.logging.Log
+
+
+ +
Returns:
true
See Also:
Log.isErrorEnabled()
+
+
+
+ +

+isFatalEnabled

+
+public boolean isFatalEnabled()
+
+
Enabled. +

+

+
Specified by:
isFatalEnabled in interface org.apache.commons.logging.Log
+
+
+ +
Returns:
true
See Also:
Log.isFatalEnabled()
+
+
+
+ +

+isInfoEnabled

+
+public boolean isInfoEnabled()
+
+
Disabled. +

+

+
Specified by:
isInfoEnabled in interface org.apache.commons.logging.Log
+
+
+ +
Returns:
false
See Also:
Log.isInfoEnabled()
+
+
+
+ +

+isTraceEnabled

+
+public boolean isTraceEnabled()
+
+
Disabled. +

+

+
Specified by:
isTraceEnabled in interface org.apache.commons.logging.Log
+
+
+ +
Returns:
false
See Also:
Log.isTraceEnabled()
+
+
+
+ +

+isWarnEnabled

+
+public boolean isWarnEnabled()
+
+
Disabled. +

+

+
Specified by:
isWarnEnabled in interface org.apache.commons.logging.Log
+
+
+ +
Returns:
false
See Also:
Log.isWarnEnabled()
+
+
+
+ +

+trace

+
+public void trace(Object message)
+
+
Ignored. +

+

+
Specified by:
trace in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
See Also:
Log.trace(java.lang.Object)
+
+
+
+ +

+trace

+
+public void trace(Object message,
+                  Throwable t)
+
+
Ignored. +

+

+
Specified by:
trace in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
t - possibly null
See Also:
Log.trace(java.lang.Object, java.lang.Throwable)
+
+
+
+ +

+warn

+
+public void warn(Object message)
+
+
Ignored. +

+

+
Specified by:
warn in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
See Also:
Log.warn(java.lang.Object)
+
+
+
+ +

+warn

+
+public void warn(Object message,
+                 Throwable t)
+
+
Ignored. +

+

+
Specified by:
warn in interface org.apache.commons.logging.Log
+
+
+
Parameters:
message - possibly null
t - possibly null
See Also:
Log.warn(java.lang.Object, java.lang.Throwable)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011-2012 Apache Software Foundation. All Rights Reserved. + + Propchange: incubator/rat/site/trunk/content/rat/whisker/apidocs/org/apache/creadur/whisker/cli/SystemLog.html ------------------------------------------------------------------------------ svn:eol-style = native