org.unix4j.unix.cat.CatOptions Maven / Gradle / Ivy
package org.unix4j.unix.cat;
import java.util.Collections;
import java.util.Iterator;
import org.unix4j.convert.OptionSetConverters.OptionSetConverter;
import org.unix4j.convert.ValueConverter;
import org.unix4j.option.DefaultOptionSet;
import org.unix4j.option.Option;
import org.unix4j.option.OptionSet;
import org.unix4j.unix.Cat;
import org.unix4j.unix.cat.CatOption;
/**
* Interface implemented by all option sets for the {@link Cat cat} command.
* It is recommended to use {@link Cat#Options} to specify a valid
* combination of options.
*
* The options for the cat command are:
*
*
* {@code -b} {@code --numberNonBlankLines} Number the non-blank output lines, starting at 1. {@code -n} {@code --numberLines} Number the output lines, starting at 1. {@code -s} {@code --squeezeEmptyLines} Squeeze multiple adjacent empty lines, causing the output to be
single spaced.
*
* This interface serves as an alias for the extended interface to simplify the
* command signature methods by avoiding generic parameters.
*/
public interface CatOptions extends OptionSet {
/**
* Constant for an empty option set.
*/
CatOptions EMPTY = new CatOptions() {
@Override
public Class optionType() {
return CatOption.class;
}
@Override
public boolean isSet(CatOption option) {
return false;
}
/**
* Returns 0 as this is a set with no active options.
*
* @return zero
*/
@Override
public int size() {
return 0;
}
/**
* Returns an immutable empty set.
*
* @return an immutable empty set.
*/
@Override
public java.util.Set asSet() {
return Collections.emptySet();
}
/**
* Returns an iterator returning no elements.
*
* @return an immutable iterator with no elements.
*/
@Override
public Iterator iterator() {
return asSet().iterator();
}
/**
* Returns true if the {@link Option#acronym() acronym} should be used
* for the specified {@code option} in string representations.
*
* This method returns always true;
*
* @param option
* the option of interest
* @return always true
*/
@Override
public boolean useAcronymFor(CatOption option) {
return true;
}
};
/**
* Default implementation for a modifiable option set.
*/
class Default extends DefaultOptionSet implements CatOptions {
/**
* Default constructor for an empty option set with no active options.
*/
public Default() {
super(CatOption.class);
}
/**
* Constructor for an option set with a single active option.
* @param option the option to be set
*/
public Default(CatOption option) {
super(option);
}
/**
* Constructor for an option set with the given active options.
* @param options the options to be set
*/
public Default(CatOption... options) {
this();
setAll(options);
}
/**
* Constructor for an option set initialized with the options given by
* another option set.
*
* @param optionSet set with the options to be active
*/
public Default(OptionSet optionSet) {
this();
setAll(optionSet);
}
}
/**
* Value converter for {@link CatOptions} based on an {@link OptionSetConverter}.
*/
ValueConverter CONVERTER = new ValueConverter() {
private final OptionSetConverter converter = new OptionSetConverter(CatOption.class);
@Override
public CatOptions convert(Object value) {
final OptionSet set = converter.convert(value);
return set == null ? null : new Default(set);
}
};
}