ArgParserBuilder.java

/*
 * Copyright 2022 Terminal Utils Authors
 *
 * 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.
 */

package net.morimekta.terminal.args;

import java.util.List;

/**
 * Base interface for building an argument parser.
 */
public interface ArgParserBuilder {
    /**
     * @return The built argument parser.
     */
    ArgParser build();

    /**
     * Build and parse arguments.
     *
     * @param args Argument list to parse.
     * @return The argument parser after parsing.
     */
    default ArgParser parse(List<String> args) {
        return build().parse(args);
    }

    /**
     * Build and parse arguments.
     *
     * @param args Arguments to parse.
     * @return The argument parser after parsing.
     */
    default ArgParser parse(String... args) {
        return build().parse(args);
    }
}