org.lockss.tdb.KeepGoing Maven / Gradle / Ivy
/*
Copyright (c) 2000-2018, Board of Trustees of Leland Stanford Jr. University,
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.lockss.tdb;
import java.util.*;
import org.apache.commons.cli.*;
/**
*
* Utilities defining a standard keep-going option.
*
*
* If the keep-going option created by {@link #addOptions(Options)} is requested
* on the command line processed by
* {@link #parse(Map, CommandLineAccessor)},
* {@link #isKeepGoing(Map)} will return true to indicate it; one
* can then add errors to the list of errors via
* {@link #addError(Map, Exception)} and retrieve them later via
* {@link #getErrors(Map)}.
*
*
* @author Thib Guicherd-Callin
* @since 1.72
*/
public class KeepGoing {
/**
*
* Prevent instantiation.
*
*
* @since 1.72
*/
private KeepGoing() {
// Prevent instantiation
}
/**
*
* Key for the standard input option ({@value}).
*
*
* @since 1.72
*/
public static final String KEY = "keep-going";
/**
*
* Key for the keep-going option's error list.
*
*
* @since 1.72
*/
private static final String KEY_ERRORS = KEY + "__errors";
/**
*
* Adds the standard keep-going option to a Commons CLI {@link Options}
* instance.
*
*
* @param opts
* A Commons CLI {@link Options} instance.
* @since 1.72
*/
public static Option option() {
return Option.builder(Character.toString('k'))
.longOpt(KEY)
.desc("keep going past errors through all input files")
.build();
}
/**
*
* Processes a {@link CommandLineAccessor} instance and stores appropriate
* information in the given options map.
*
*
* @param options
* An options map.
* @param cmd
* A {@link CommandLineAccessor} instance.
* @since 1.72
*/
public static void parse(Map options,
CommandLineAccessor cmd) {
options.put(KEY, Boolean.valueOf(cmd.hasOption(KEY)));
options.put(KEY_ERRORS, new ArrayList());
}
/**
*
* Determines from the options map if the keep-going option has been requested
* on the command line.
*
*
* @param options
* An options map.
* @return true if and only if the keep-going option has been
* requested on the command line.
* @since 1.72
*/
public static boolean isKeepGoing(Map options) {
Boolean keepGoing = (Boolean)options.get(KEY);
return keepGoing != null && keepGoing.booleanValue();
}
/**
*
* Adds an error to the list kept internally in the options map and proceeds.
*
*
* @param options
* The options map.
* @param exc
* An exception.
* @since 1.72
*/
public static void addError(Map options,
Exception exc) {
getErrors(options).add(exc);
}
/**
*
* Retrieves the list of errors kept internally in the options map.
*
*
* @param options
* The options map.
* @return The list of errors stored in the options map.
* @since 1.72
*/
public static List getErrors(Map options) {
return (List)options.get(KEY_ERRORS);
}
}