OutputFormat.java

/*
 * 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 org.apache.maven.cling.invoker.mvnval;

import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.function.Consumer;
import java.util.stream.Collectors;

/**
 * Output formats the validation tool understands.
 */
enum OutputFormat {
    TEXT {
        @Override
        void report(List<Report> reports, Path cwd, Consumer<String> out, int context, boolean color) {
            TextReporter.report(reports, cwd, out, context, color);
        }
    },
    JSON {
        @Override
        void report(List<Report> reports, Path cwd, Consumer<String> out, int context, boolean color) {
            // Absolute paths only: the document may be read somewhere else entirely.
            JsonReporter.report(reports, out);
        }
    };

    /**
     * Renders the reports, handing each line to {@code out} without a line separator. A format may
     * emit any number of lines per report, including one line for all of them.
     *
     * @param context number of source lines before/after each problem location (text format only)
     * @param color   whether ANSI color codes are enabled
     */
    abstract void report(List<Report> reports, Path cwd, Consumer<String> out, int context, boolean color);

    static OutputFormat parse(String name) {
        return Arrays.stream(values())
                .filter(format -> format.name().equalsIgnoreCase(name))
                .findFirst()
                .orElseThrow(() -> new IllegalArgumentException("Unknown format '" + name + "', expected one of: "
                        + Arrays.stream(values())
                                .map(format -> format.name().toLowerCase(Locale.ROOT))
                                .collect(Collectors.joining(", "))));
    }
}