javadoc

Author: h908714124

jbock/src/main/java/net/jbock/parse/AbstractParser.java

@@ -114,21 +114,7 @@ private String readOptionName(String token) {
         return token.substring(0, token.indexOf('='));
     }
 
-    /**
-     * Returns the arguments of the given option.
-     * If the option was not present on the command line,
-     * an empty stream is returned. If the option is not
-     * repeatable, the stream will contain exactly one element.
-     * For nullary options, an empty stream
-     * represents absence, and any nonempty stream represents presence
-     * of the option.
-     *
-     * <p>This method should be not be invoked before {@link #parse(List)}
-     * was invoked.
-     *
-     * @param option the option key
-     * @return a stream of strings
-     */
+    @Override
     public final Stream<String> option(T option) {
         OptionState optionState = optionStates.get(option);
         if (optionState == null) {
@@ -137,16 +123,7 @@ public final Stream<String> option(T option) {
         return optionState.stream();
     }
 
-    /**
-     * Returns the value of the positional parameter at the given position,
-     * if any.
-     *
-     * <p>This method should be not be invoked before {@link #parse(List)}
-     * was invoked.
-     *
-     * @param index the parameter position
-     * @return an optional string
-     */
+    @Override
     public final Optional<String> param(int index) {
         if (index < 0 || index >= params.length) {
             return Optional.empty();

jbock/src/main/java/net/jbock/parse/ParseResult.java

@@ -14,11 +14,6 @@ public interface ParseResult<T> {
      * Get all option values for the given option key,
      * in the order in which they were passed on the command line.
      *
-     * <p>For a non-repeatable option, the stream will not contain more than
-     * one element.
-     *
-     * <p>For a required option, the stream will contain exactly one element.
-     *
      * @param optionKey a key that represents a named option
      * @return stream of tokens
      */
@@ -40,10 +35,9 @@ public interface ParseResult<T> {
 
     /**
      * Returns the remaining tokens.
-     *
-     * <p>This stream may be nonempty if there is a {@linkplain net.jbock.VarargsParameter},
-     * or if the command is a {@linkplain net.jbock.SuperCommand}.
-     * Otherwise it will be an empty stream.
+     * This can be nonempty if there is a varargs parameter,
+     * or if this is a supercommand where parsing stops after the
+     * last positional parameter was read.
      *
      * @return remaining tokens
      */

jbock/src/main/java/net/jbock/parse/VarargsParameterParser.java

@@ -6,9 +6,9 @@
 import java.util.stream.Stream;
 
 /**
- * Mutable command line parser that allows additional
- * non-option tokens after the last positional parameter.
- * This parser rejects suspicious tokens, and allows
+ * Mutable command line parser that allows an arbitrary number of additional
+ * tokens after the last positional parameter.
+ * The parser rejects unknown option-like tokens, and recognizes
  * double-dash escape.
  *
  * @param <T> type of keys that identify named options