Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
|Type||Name and description|
An implementation of Parser's abstract flatten method.
token into its constituent parts
using the following algorithm.
stopAtNonOptionIS set then add the special token "--" followed by the remaining characters and also the remaining tokens directly to the processed tokens list.
stopAtNonOptionIS NOT set then add that character prepended with "-".
token- The current token to be burst
stopAtNonOption- Specifies whether to stop processing at the first non-Option encountered.
The following are the rules used by this flatten method.
stopAtNonOptionis true then do not burst anymore of
argumentsentries, just add each successive entry without further processing. Otherwise, ignore
argumentsentry is "--" just add the entry to the list of processed tokens
argumentsentry is "-" just add the entry to the list of processed tokens
argumentsentry is two characters in length and the first character is "-" then check if this is a valid Option id. If it is a valid id, then add the entry to the list of processed tokens and set the current Option member. If it is not a valid id and
stopAtNonOptionis true, then the remaining entries are copied to the list of processed tokens. Otherwise, the current entry is ignored.
argumentsentry is more than two characters in length and the first character is "-" then we need to burst the entry to determine its constituents. For more information on the bursting algorithm see burstToken.
argumentsentry is not handled by any of the previous rules, then the entry is added to the list of processed tokens.
options- The command line Options
arguments- The command line arguments to be parsed
stopAtNonOption- Specifies whether to stop flattening when an non option is found.