View Javadoc

1   /***
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.cli;
18  
19  /***
20   * The class BasicParser provides a very simple implementation of
21   * the {@link Parser#flatten(Options,String[],boolean) flatten} method.
22   *
23   * @author John Keyes (john at integralsource.com)
24   * @see Parser
25   */
26  public class BasicParser extends Parser {
27  
28      /***
29       * <p>A simple implementation of {@link Parser}'s abstract
30       * {@link Parser#flatten(Options,String[],boolean) flatten} method.</p>
31       *
32       * <p><b>Note:</b> <code>options</code> and <code>stopAtNonOption</code>
33       * are not used in this <code>flatten</code> method.</p>
34       *
35       * @param options The command line {@link Options}
36       * @param arguments The command line arguments to be parsed
37       * @param stopAtNonOption Specifies whether to stop flattening
38       * when an non option is found.
39       * @return The <code>arguments</code> String array.
40       */
41      protected String[] flatten(Options options, String[] arguments, 
42                                 boolean stopAtNonOption)
43      {
44          // just echo the arguments
45          return arguments;
46      }
47  }