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
18 package org.apache.commons.cli;
19
20 /**
21 * The class BasicParser provides a very simple implementation of the {@link Parser#flatten(Options,String[],boolean)
22 * flatten} method.
23 *
24 * @deprecated since 1.3, use the {@link DefaultParser} instead
25 */
26 @Deprecated
27 public class BasicParser extends Parser {
28 /**
29 * <p>
30 * A simple implementation of {@link Parser}'s abstract {@link Parser#flatten(Options, String[], boolean) flatten}
31 * method.
32 * </p>
33 *
34 * <p>
35 * <b>Note:</b> {@code options} and {@code stopAtNonOption} are not used in this {@code flatten} method.
36 * </p>
37 *
38 * @param options The command line {@link Options}
39 * @param arguments The command line arguments to be parsed
40 * @param stopAtNonOption Specifies whether to stop flattening when an non option is found.
41 * @return The {@code arguments} String array.
42 */
43 @Override
44 protected String[] flatten(@SuppressWarnings("unused") final Options options, final String[] arguments,
45 @SuppressWarnings("unused") final boolean stopAtNonOption) {
46 // just echo the arguments
47 return arguments;
48 }
49 }