com.senzing.cmdline.CommandLineOption Maven / Gradle / Ivy
package com.senzing.cmdline;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
/**
* Interface for {@link Enum} classes that represent command line options
* to enable them to be used with {@link CommandLineUtilities}.
*
* @param The enumerated type that enumerates the command-line options.
* @param The base enumerated type that these command-line options extend,
* OR the same as type T if this command-line
* option type has no base and returns null from
* {@link #getBaseOptionType()}.
*/
public interface CommandLineOption & CommandLineOption,
B extends Enum & CommandLineOption>
{
/**
* Gets the base {@link CommandLineOption} type that this one extends. This
* returns null if there is no base type. NOTE: The type
* returned is the base generic parameter type or the same type of this class
* if no base.
*
* @return The base {@link CommandLineOption} type that this one extends, or
* null if there is no base type.
*/
default Class getBaseOptionType() {
return null;
}
/**
* Gets the {@link String} command line flag associated with this option.
*
* @return The {@link String} command line flag associated with this option.
*/
String getCommandLineFlag();
/**
* Gets the unmodifiable {@link Set} of {@link String} synonym flags
* for this option. These are alternate command-line flags that can be used
* instead of the primary flag specified by {@link #getCommandLineFlag()}.
* This is useful when a flag changes and the old version of it is
* deprecated but still supported. It is NOT allowed to pass multiple
* flags for the same option.
*
* @return The unmodifiable {@link Set} of {@link String} synonym flags
* for this optional, or an empty set if there are no synonyms.
*/
default Set getSynonymFlags() {
return Collections.emptySet();
}
/**
* Gets the environment variable that can be used to set the value for
* this option, or null if the value for this option cannot be
* set with an environment variable.
*
* @return The environment variable that can be used to set the value for
* this option, or null if the value for this option
* cannot be set with an environment variable.
*/
default String getEnvironmentVariable() {
return null;
}
/**
* Gets the unmodifiable {@link Set} of {@link String} synonym
* environment variables for this option. These are alternate environment
* variables that can be used instead of the primary environment variable
* specified by {@link #getEnvironmentVariable()}. This is useful when an
* environment variable changes and the old version of it is deprecated but
* still supported. Having multiple environment variables set in the
* environment for this option is allowed, however, they are taken in order
* of preference (first the primary environment variable and then each of
* those in returned {@link Set} in order).
*
* @return The unmodifiable {@link Set} of {@link String} synonym flags
* for this optionl, or an empty set if there are no synonyms.
*
*/
default Set getEnvironmentSynonyms() {
return Collections.emptySet();
}
/**
* Gets the unmodifiable {@link List} of {@link String} fall-back
* environment variables for this option. These are environment variables
* that are only checked if another option is specified that is dependent
* on this option and this option is missing. The environment variables
* in the returned {@link List} are checked in order until the first one is
* found. These are essentially environment synonyms that are only
* conditionally checked until the first is found.
*
* @return The ordered {@link List} of {@link String} fall-back environment
* variables.
*/
default List getEnvironmentFallbacks() {
return Collections.emptyList();
}
/**
* Gets an {@link Set} of options that conflict with this option.
*
* @return An {@link Set} of options that conflict with this option.
*/
default Set getConflicts() {
return Collections.emptySet();
}
/**
* Gets the {@link Set} of {@link Set} instances describing combinations
* of sets of options that this option depends on. At least one of the
* contained {@link Set} instances must be satisfied for this option to
* be used.
*
* @return The {@link Set} of {@link Set} instances describing
* combinations of sets of options that this option depends on.
*/
default Set> getDependencies() {
return Collections.emptySet();
}
/**
* Returns the {@link Set} of alternative options to use in place of a
* deprecated option.
*
* @return The {@link Set} of alternative options to use in place of a
* deprecated option.
*/
default Set getDeprecationAlternatives() {
return Collections.emptySet();
}
/**
* Checks if this command line option is a primary option. At least one
* primary option must be specified. Whether or not multiple primary options
* are allowed depends on the {@linkplain #getConflicts() conflicts} for
* each option.
*
* @return true if this option is a primary option, otherwise
* false.
*/
default boolean isPrimary() {
return false;
}
/**
* Checks if this command line option is deprecated.
*
* @return true if this option is deprecated, otherwise
* false.
*/
default boolean isDeprecated() {
return false;
}
/**
* Checks if the command-line option has a value that is considered
* sensitive and should not be logged.
*
* @return true if the option's value is considered sensitive,
* and fals
*/
default boolean isSensitive() {
final int PUBLIC_STATIC = Modifier.PUBLIC | Modifier.STATIC;
Class c = this.getClass();
Field[] fields = c.getFields();
for (Field field : fields) {
// skip this one if not public and static
if ((field.getModifiers() & PUBLIC_STATIC) == 0) continue;
try {
if (field.get(null) == this) {
String fieldName = field.getName().toUpperCase();
return (fieldName.equals("PASSWORD")
|| fieldName.endsWith("_PASSWORD"));
}
} catch (IllegalAccessException ignore) {
continue;
}
}
return false;
}
/**
* Returns the minimum number of additional parameters that should follow this
* command line option. This should return a non-negative number and at least
* this many parameters will be consumed. By default this returns zero (0).
*
* @return The minimum number of additional parameters that should follow this
* command line option.
*/
default int getMinimumParameterCount() {
return 0;
}
/**
* Returns the maximum number of additional parameters that should follow this
* command line option. If this returns a negative number then parameters
* are read until the next recognized command line option is read after
* consuming at least the {@linkplain #getMinimumParameterCount()} minimum
* number of parameters}. By default this returns negative one (-1).
*
* @return The maximum number of additional parameters that should follow this
* command line option, or a negative number to indicate that
* parameters should be read until the next recognized command line
* option is read.
*/
default int getMaximumParameterCount() {
return -1;
}
/**
* Returns the default parameter values associated with the option. These are
* the parameters that are set if none are specified. If no default
* parameters then this returns null. An empty {@link List}
* indicates that the option is specified by default but with no parameters.
* The default implementation returns null.
*
* @return The default parameter values associated with the option.
*/
default List getDefaultParameters() {
return null;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy