You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by ro...@apache.org on 2018/12/21 22:12:56 UTC
svn commit: r1849500 - in /felix/trunk/gogo: itest-jline/ itest-shell/
runtime/src/main/java/org/apache/felix/gogo/runtime/
runtime/src/main/java/org/apache/felix/gogo/runtime/threadio/
runtime/src/main/java/org/apache/felix/service/command/ runtime/sr...
Author: rotty3000
Date: Fri Dec 21 22:12:56 2018
New Revision: 1849500
URL: http://svn.apache.org/viewvc?rev=1849500&view=rev
Log:
[gogo] fix javadoc errors
Signed-off-by: Raymond Auge <ro...@apache.org>
Modified:
felix/trunk/gogo/itest-jline/pom.xml
felix/trunk/gogo/itest-shell/pom.xml
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ArgList.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expander.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expression.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/GlobPathMatcher.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Reflective.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ThreadUtils.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/threadio/ThreadInputStream.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandProcessor.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandSession.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Converter.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Function.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Process.java
felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/threadio/ThreadIO.java
felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/options/Option.java
felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Builtin.java
felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Posix.java
Modified: felix/trunk/gogo/itest-jline/pom.xml
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/itest-jline/pom.xml?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/itest-jline/pom.xml (original)
+++ felix/trunk/gogo/itest-jline/pom.xml Fri Dec 21 22:12:56 2018
@@ -43,6 +43,7 @@
<properties>
<maven.deploy.skip>true</maven.deploy.skip>
<maven.install.skip>true</maven.install.skip>
+ <maven.javadoc.skip>true</maven.javadoc.skip>
</properties>
<dependencies>
Modified: felix/trunk/gogo/itest-shell/pom.xml
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/itest-shell/pom.xml?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/itest-shell/pom.xml (original)
+++ felix/trunk/gogo/itest-shell/pom.xml Fri Dec 21 22:12:56 2018
@@ -43,6 +43,7 @@
<properties>
<maven.deploy.skip>true</maven.deploy.skip>
<maven.install.skip>true</maven.install.skip>
+ <maven.javadoc.skip>true</maven.javadoc.skip>
</properties>
<dependencies>
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ArgList.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ArgList.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ArgList.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ArgList.java Fri Dec 21 22:12:56 2018
@@ -25,7 +25,7 @@ import java.util.List;
* List that overrides toString() for implicit $args expansion.
* Also checks for index out of bounds, so that $1 evaluates to null
* rather than throwing IndexOutOfBoundsException.
- * e.g. x = { a$args }; x 1 2 => a1 2 and not a[1, 2]
+ * e.g. x = { a$args }; x 1 2 => a1 2 and not a[1, 2]
*/
public class ArgList extends AbstractList<Object>
{
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expander.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expander.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expander.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expander.java Fri Dec 21 22:12:56 2018
@@ -47,6 +47,10 @@ public class Expander extends BaseTokeni
/**
* expand variables, quotes and escapes in word.
+ * @param word the word
+ * @param eval the eval
+ * @return Object
+ * @throws Exception on exception
*/
public static Object expand(CharSequence word, Evaluate eval) throws Exception
{
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expression.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expression.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expression.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Expression.java Fri Dec 21 22:12:56 2018
@@ -95,13 +95,13 @@ import java.util.Stack;
*
* result = new Expression("2.4/PI").setPrecision(128).setRoundingMode(RoundingMode.UP).eval();
*
- * result = new Expression("random() > 0.5").eval();
+ * result = new Expression("random() > 0.5").eval();
*
- * result = new Expression("not(x<7 || sqrt(max(x,9)) <= 3))").with("x","22.9").eval();
+ * result = new Expression("not(x < 7 || sqrt(max(x,9)) <= 3))").with("x","22.9").eval();
* </pre>
* <br>
* <h2>Supported Operators</h2>
- * <table>
+ * <table summary="Mathematical Operators">
* <tr><th>Mathematical Operators</th></tr>
* <tr><th>Operator</th><th>Description</th></tr>
* <tr><td>+</td><td>Additive operator</td></tr>
@@ -112,7 +112,7 @@ import java.util.Stack;
* <tr><td>^</td><td>Power operator</td></tr>
* </table>
* <br>
- * <table>
+ * <table summary="Boolean Operators">
* <tr><th>Boolean Operators<sup>*</sup></th></tr>
* <tr><th>Operator</th><th>Description</th></tr>
* <tr><td>=</td><td>Equals</td></tr>
@@ -129,7 +129,7 @@ import java.util.Stack;
* *Boolean operators result always in a BigDecimal value of 1 or 0 (zero). Any non-zero value is treated as a _true_ value. Boolean _not_ is implemented by a function.
* <br>
* <h2>Supported Functions</h2>
- * <table>
+ * <table summary="Supported Functions">
* <tr><th>Function<sup>*</sup></th><th>Description</th></tr>
* <tr><td>NOT(<i>expression</i>)</td><td>Boolean negation, 1 (means true) if the expression is not zero</td></tr>
* <tr><td>IF(<i>condition</i>,<i>value_if_true</i>,<i>value_if_false</i>)</td><td>Returns one value if the condition evaluates to true or the other if it evaluates to false</td></tr>
@@ -154,7 +154,7 @@ import java.util.Stack;
* *Functions names are case insensitive.
* <br>
* <h2>Supported Constants</h2>
- * <table>
+ * <table summary="Supported Constants">
* <tr><th>Constant</th><th>Description</th></tr>
* <tr><td>PI</td><td>The value of <i>PI</i>, exact to 100 digits</td></tr>
* <tr><td>TRUE</td><td>The value one</td></tr>
@@ -167,12 +167,12 @@ import java.util.Stack;
* Parameters are the operator string, its precedence and if it is left associative. The operators `eval()` method will be called with the BigDecimal values of the operands.
* All existing operators can also be overridden.
* <br>
- * For example, add an operator `x >> n`, that moves the decimal point of _x_ _n_ digits to the right:
+ * For example, add an operator `x >> n`, that moves the decimal point of _x_ _n_ digits to the right:
*
* <pre>
- * Expression e = new Expression("2.1234 >> 2");
+ * Expression e = new Expression("2.1234 >> 2");
*
- * e.addOperator(e.new Operator(">>", 30, true) {
+ * e.addOperator(e.new Operator(">>", 30, true) {
* {@literal @}Override
* public BigDecimal eval(BigDecimal v1, BigDecimal v2) {
* return v1.movePointRight(v2.toBigInteger().intValue());
@@ -195,7 +195,7 @@ import java.util.Stack;
*
* e.addFunction(e.new Function("average", 3) {
* {@literal @}Override
- * public BigDecimal eval(List<BigDecimal> parameters) {
+ * public BigDecimal eval(List<BigDecimal> parameters) {
* BigDecimal sum = parameters.get(0).add(parameters.get(1)).add(parameters.get(2));
* return sum.divide(new BigDecimal(3));
* }
@@ -643,7 +643,7 @@ public class Expression {
*
* @param expression
* The expression. E.g. <code>"2.4*sin(3)/(2-4)"</code> or
- * <code>"sin(y)>0 & max(z, 3)>3"</code>
+ * <code>"sin(y)>0 & max(z, 3)>3"</code>
*/
public Expression(String expression) {
this.expression = expression;
@@ -1169,6 +1169,7 @@ public class Expression {
/**
* Evaluates the expression.
*
+ * @param variables the variables
* @return The result of the expression.
*/
public Object eval(Map<String, Object> variables) {
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/GlobPathMatcher.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/GlobPathMatcher.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/GlobPathMatcher.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/GlobPathMatcher.java Fri Dec 21 22:12:56 2018
@@ -44,6 +44,7 @@ public class GlobPathMatcher {
/**
* Create a new instance with the {@link #DEFAULT_PATH_SEPARATOR}.
+ * @param pattern the pattern
*/
public GlobPathMatcher(String pattern) {
this(pattern, DEFAULT_PATH_SEPARATOR, true);
@@ -51,7 +52,9 @@ public class GlobPathMatcher {
/**
* A convenient, alternative constructor to use with a custom path separator.
+ * @param pattern the pattern
* @param pathSeparator the path separator to use, must not be {@code null}.
+ * @param caseSensitive is case sensitive
*/
public GlobPathMatcher(String pattern, String pathSeparator, boolean caseSensitive) {
Objects.requireNonNull(pathSeparator, "'pathSeparator' is required");
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Reflective.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Reflective.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Reflective.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/Reflective.java Fri Dec 21 22:12:56 2018
@@ -53,8 +53,12 @@ public final class Reflective
/**
* invokes the named method on the given target using the supplied args,
* which are converted if necessary.
+ * @param session the session
+ * @param target the target
+ * @param name the name
+ * @param args the args
* @return the result of the invoked method
- * @throws Exception
+ * @throws Exception on exception
*/
public static Object invoke(CommandSession session, Object target, String name,
List<Object> args) throws Exception
@@ -418,6 +422,9 @@ public final class Reflective
/**
* converts given argument to specified type and increments convert[0] if any conversion was needed.
+ * @param session the session
+ * @param type the type
+ * @param arg the arg
* @param convert convert[0] is incremented according to the conversion needed,
* to allow the "best" conversion to be determined.
* @return converted arg or NO_MATCH if no conversion possible.
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ThreadUtils.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ThreadUtils.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ThreadUtils.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/ThreadUtils.java Fri Dec 21 22:12:56 2018
@@ -24,7 +24,7 @@ public class ThreadUtils {
/**
* Constructs threads with names <code><prefix>-<pool number>-thread-<thread number></code>.
* @param prefix prefix to be used for thread names created by this {@link ThreadFactory}
- * @return
+ * @return ThreadFactory
*/
public static ThreadFactory namedThreadFactory(String prefix) {
return new NamedThreadFactory(prefix);
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/threadio/ThreadInputStream.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/threadio/ThreadInputStream.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/threadio/ThreadInputStream.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/gogo/runtime/threadio/ThreadInputStream.java Fri Dec 21 22:12:56 2018
@@ -40,6 +40,7 @@ public class ThreadInputStream extends I
/**
* Access to the root stream through reflection
+ * @return InputStream
*/
public InputStream getRoot()
{
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandProcessor.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandProcessor.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandProcessor.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandProcessor.java Fri Dec 21 22:12:56 2018
@@ -38,7 +38,7 @@ public interface CommandProcessor
* A list of method names that may be called for this command provider. A
* name may end with a *, this will then be calculated from all declared public
* methods in this service.
- * <p/>
+ * <p>
* Help information for the command may be supplied with a space as
* separation.
*/
@@ -46,11 +46,11 @@ public interface CommandProcessor
/**
* Create a new command session associated with IO streams.
- * <p/>
+ * <p>
* The session is bound to the life cycle of the bundle getting this
* service. The session will be automatically closed when this bundle is
* stopped or the service is returned.
- * <p/>
+ * <p>
* The shell will provide any available commands to this session and
* can set additional variables.
*
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandSession.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandSession.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandSession.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/CommandSession.java Fri Dec 21 22:12:56 2018
@@ -42,16 +42,15 @@ public interface CommandSession extends
/**
* Execute a program in this session.
*
- * @param commandline
+ * @param commandline the commandline
* @return the result of the execution
+ * @throws Exception on exception
*/
Object execute(CharSequence commandline) throws Exception;
/**
* Close this command session. After the session is closed, it will throw
* IllegalStateException when it is used.
- *
- * @param
*/
void close();
@@ -72,15 +71,15 @@ public interface CommandSession extends
* bypass the piping. If the output is piped to a file, then the object
* returned must be null.
*
- * @return
+ * @return PrintStream the console print stream
*/
PrintStream getConsole();
/**
* Get the value of a variable.
*
- * @param name
- * @return
+ * @param name the name
+ * @return Object
*/
Object get(String name);
@@ -89,6 +88,7 @@ public interface CommandSession extends
*
* @param name Name of the variable.
* @param value Value of the variable
+ * @return Object
*/
Object put(String name, Object value);
@@ -98,16 +98,18 @@ public interface CommandSession extends
* function always returns a non null value. As a last resort, toString is
* called on the Object.
*
- * @param target
- * @param level
- * @return
+ * @param target the target
+ * @param level the level
+ * @return CharSequence
*/
CharSequence format(Object target, int level);
/**
* Convert an object to another type.
+ * @param type the type
+ * @param instance the instance
+ * @return Object
*/
-
Object convert(Class<?> type, Object instance);
//
@@ -116,16 +118,19 @@ public interface CommandSession extends
/**
* List jobs. Always return a non-null list.
+ * @return List<Job>
*/
List<Job> jobs();
/**
* Get the current foreground job or null.
+ * @return Job
*/
Job foregroundJob();
/**
* Set the job listener for this session.
+ * @param listener the listener
*/
void setJobListener(JobListener listener);
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Converter.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Converter.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Converter.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Converter.java Fri Dec 21 22:12:56 2018
@@ -21,11 +21,11 @@ package org.apache.felix.service.command
/**
* A converter is a service that can help create specific object types from a
* string, and vice versa.
- * <p/>
+ * <p>
* The shell is capable of coercing arguments to the their proper type. However,
* sometimes commands require extra help to do this conversion. This service can
* implement a converter for a number of types.
- * <p/>
+ * <p>
* The command shell will rank these services in order of service.ranking and
* will then call them until one of the converters succeeds.
*/
@@ -59,14 +59,14 @@ public interface Converter
/**
* Convert an object to the desired type.
- * <p/>
+ * <p>
* Return null if the conversion can not be done. Otherwise return and
* object that extends the desired type or implements it.
*
* @param desiredType The type that the returned object can be assigned to
* @param in The object that must be converted
* @return An object that can be assigned to the desired type or null.
- * @throws Exception
+ * @throws Exception on exception
*/
Object convert(Class<?> desiredType, Object in) throws Exception;
@@ -79,7 +79,7 @@ public interface Converter
* @param level One of INSPECT, LINE, or PART.
* @param escape Use this object to format sub ordinate objects.
* @return A printed object of potentially multiple lines
- * @throws Exception
+ * @throws Exception on exception
*/
CharSequence format(Object target, int level, Converter escape) throws Exception;
}
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Function.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Function.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Function.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Function.java Fri Dec 21 22:12:56 2018
@@ -29,6 +29,8 @@ public interface Function
/**
* Execute this function and return the result.
*
+ * @param session the session
+ * @param arguments the arguments
* @return the result from the execution.
* @throws Exception if anything goes terribly wrong
*/
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Process.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Process.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Process.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/command/Process.java Fri Dec 21 22:12:56 2018
@@ -40,16 +40,20 @@ public interface Process
/**
* Get the job controlling this process
+ * @return Job
*/
Job job();
/**
* Check if the given descriptor for the currently running pipe is the terminal or not.
+ * @param fd the fd
+ * @return boolean
*/
boolean isTty(int fd);
/**
* Set the error code for the currently running pipe.
+ * @param error the error
*/
void error(int error);
Modified: felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/threadio/ThreadIO.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/threadio/ThreadIO.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/threadio/ThreadIO.java (original)
+++ felix/trunk/gogo/runtime/src/main/java/org/apache/felix/service/threadio/ThreadIO.java Fri Dec 21 22:12:56 2018
@@ -23,7 +23,7 @@ import java.io.PrintStream;
/**
* Enable multiplexing of the standard IO streams for input, output, and error.
- * <p/>
+ * <p>
* This service guards the central resource of IO streams. The standard streams
* are singletons. This service replaces the singletons with special versions that
* can find a unique stream for each thread. If no stream is associated with a
@@ -35,10 +35,10 @@ public interface ThreadIO
{
/**
* Associate this streams with the current thread.
- * <p/>
+ * <p>
* Ensure that when output is performed on System.in, System.out, System.err it
* will happen on the given streams.
- * <p/>
+ * <p>
* The streams will automatically be canceled when the bundle that has gotten
* this service is stopped or returns this service.
*
@@ -50,7 +50,7 @@ public interface ThreadIO
/**
* Cancel the streams associated with the current thread.
- * <p/>
+ * <p>
* This method will not do anything when no streams are associated.
*/
void close();
Modified: felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/options/Option.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/options/Option.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/options/Option.java (original)
+++ felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/options/Option.java Fri Dec 21 22:12:56 2018
@@ -24,67 +24,76 @@ public interface Option {
/**
* stop parsing on the first unknown option. This allows one parser to get its own options and
* then pass the remaining options to another parser.
- *
- * @param stopOnBadOption
+ *
+ * @param stopOnBadOption stopOnBadOption
+ * @return Option
*/
Option setStopOnBadOption(boolean stopOnBadOption);
/**
* require options to precede args. Default is false, so options can appear between or after
* args.
- *
- * @param optionsFirst
+ *
+ * @param optionsFirst optionsFirst
+ * @return Option
*/
Option setOptionsFirst(boolean optionsFirst);
/**
* parse arguments. If skipArgv0 is true, then parsing begins at arg1. This allows for commands
* where argv0 is the command name rather than a real argument.
- *
- * @param argv
- * @param skipArg0
- * @return
+ *
+ * @param argv argv
+ * @param skipArg0 skipArg0
+ * @return Option
*/
Option parse(List<?> argv, boolean skipArg0);
/**
* parse arguments.
- *
- * @see {@link #parse(List, boolean)
-
+ *
+ * See {@link #parse(List, boolean)}
+ *
+ * @param argv the arg
+ * @return Option
*/
Option parse(List<?> argv);
/**
* parse arguments.
- *
- * @see {@link #parse(List, boolean)
-
+ *
+ * See {@link #parse(List, boolean)}
+ *
+ * @param argv the arg
+ * @param skipArg0 skipArg0
+ * @return Option
*/
Option parse(Object[] argv, boolean skipArg0);
/**
* parse arguments.
- *
- * @see {@link #parse(List, boolean)
-
+ *
+ * See {@link #parse(List, boolean)}
+ *
+ * @param argv argv
+ * @return Option
*/
Option parse(Object[] argv);
/**
* test whether specified option has been explicitly set.
- *
- * @param name
- * @return
+ *
+ * @param name name
+ * @return boolean
*/
boolean isSet(String name);
/**
* get value of named option. If multiple options given, this method returns the last one. Use
* {@link #getList(String)} to get all values.
- *
- * @param name
- * @return
+ *
+ * @param name the name
+ * @return String
* @throws IllegalArgumentException
* if value is not a String.
*/
@@ -92,8 +101,8 @@ public interface Option {
/**
* get list of all values for named option.
- *
- * @param name
+ *
+ * @param name the name
* @return empty list if option not given and no default specified.
* @throws IllegalArgumentException
* if all values are not Strings.
@@ -103,25 +112,25 @@ public interface Option {
/**
* get value of named option as an Object. If multiple options given, this method returns the
* last one. Use {@link #getObjectList(String)} to get all values.
- *
- * @param name
- * @return
+ *
+ * @param name the name
+ * @return Object
*/
Object getObject(String name);
/**
* get list of all Object values for named option.
- *
- * @param name
- * @return
+ *
+ * @param name the name
+ * @return List<Object>
*/
List<Object> getObjectList(String name);
/**
* get value of named option as a Number.
- *
- * @param name
- * @return
+ *
+ * @param name the name
+ * @return int
* @throws IllegalArgumentException
* if argument is not a Number.
*/
@@ -129,8 +138,8 @@ public interface Option {
/**
* get remaining non-options args as Strings.
- *
- * @return
+ *
+ * @return List<String>
* @throws IllegalArgumentException
* if args are not Strings.
*/
@@ -138,8 +147,8 @@ public interface Option {
/**
* get remaining non-options args as Objects.
- *
- * @return
+ *
+ * @return List<Object>
*/
List<Object> argObjects();
@@ -151,8 +160,8 @@ public interface Option {
/**
* print specified usage error to System.err. You should explicitly throw the returned
* exception.
- *
- * @param error
+ *
+ * @param error the error
* @return IllegalArgumentException
*/
IllegalArgumentException usageError(String error);
Modified: felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Builtin.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Builtin.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Builtin.java (original)
+++ felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Builtin.java Fri Dec 21 22:12:56 2018
@@ -60,7 +60,7 @@ public class Builtin
{
return format(session, session.get("_")); // last result
}
-
+
public CharSequence format(CommandSession session, Object arg)
{
CharSequence result = session.format(arg, Converter.INSPECT);
@@ -70,6 +70,9 @@ public class Builtin
/**
* script access to Options.
+ * @param spec the spec
+ * @param args the args
+ * @return Option
*/
public Option getopt(List<Object> spec, Object[] args)
{
@@ -310,7 +313,7 @@ public class Builtin
opt.usage();
return true;
}
-
+
boolean all = opt.isSet("all");
String optScope = null;
Modified: felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Posix.java
URL: http://svn.apache.org/viewvc/felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Posix.java?rev=1849500&r1=1849499&r2=1849500&view=diff
==============================================================================
--- felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Posix.java (original)
+++ felix/trunk/gogo/shell/src/main/java/org/apache/felix/gogo/shell/Posix.java Fri Dec 21 22:12:56 2018
@@ -34,8 +34,8 @@ import org.apache.felix.service.command.
/**
* Posix-like utilities.
- *
- * @see http://www.opengroup.org/onlinepubs/009695399/utilities/contents.html
+ *
+ * See http://www.opengroup.org/onlinepubs/009695399/utilities/contents.html
*/
public class Posix
{