Added output format options enum

This commit is contained in:
Erik C. Thauvin 2024-04-29 03:48:37 -07:00
parent 0c0222800b
commit 3f0c0ee51b
Signed by: erik
GPG key ID: 776702A6A2DA330E
2 changed files with 40 additions and 7 deletions

View file

@ -0,0 +1,32 @@
/*
* Copyright 2023-2004 the original author or authors.
*
* Licensed 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
*
* https://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 rife.bld.extension;
/**
* The Checkstyle output format for XML, sarif and default (plaib) logger.
*/
public enum CheckstyleFormatOption {
XML("xml"),
SARIF("sarif"),
PLAIN("plain");
public final String label;
CheckstyleFormatOption(String label) {
this.label = label;
}
}

View file

@ -225,16 +225,17 @@ public class CheckstyleOperation extends AbstractProcessOperation<CheckstyleOper
}
/**
* Specifies the output format. Valid values: {@code xml}, {@code sarif}, {@code plain} for the XML, sarif and
* default logger respectively. Defaults to {@code plain}.
* Specifies the output format. Valid values: {@link CheckstyleFormatOption#XML},
* {@link CheckstyleFormatOption#SARIF}, {@link CheckstyleFormatOption#PLAIN} for the XML, sarif and default logger
* respectively.
* <p>
* Defaults to {@link CheckstyleFormatOption#PLAIN}.
*
* @param format the format
* @param format the output format
* @return the checkstyle operation
*/
public CheckstyleOperation format(String format) {
if (isNotBlank(format)) {
options.put("-f", format);
}
public CheckstyleOperation format(CheckstyleFormatOption format) {
options.put("-f", format.label.toLowerCase());
return this;
}