org.unix4j.unix.ls.LsOptions Maven / Gradle / Ivy
package org.unix4j.unix.ls;
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.Ls;
import org.unix4j.unix.ls.LsOption;
/**
* Interface implemented by all option sets for the {@link Ls ls} command.
* It is recommended to use {@link Ls#Options} to specify a valid
* combination of options.
*
* The options for the ls command are:
*
*
* {@code -a} {@code --allFiles} Lists all files in the given directory, including hidden files
(those whose names start with \".\" in Unix). By default, these
files are excluded from the list. {@code -h} {@code --humanReadable} Print sizes in human readable format. (e.g., 1K, 234M, 2G, etc.) {@code -l} {@code --longFormat} Long format, displaying file types, permissions, number of hard
links, owner, group, size, date, and filename. {@code -R} {@code --recurseSubdirs} Recursively lists subdirectories encountered. {@code -r} {@code --reverseOrder} Reverses the order of the sort to get reverse collating sequence or
oldest first. {@code -t} {@code --timeSorted} Sorts with the primary key being time modified (most recently
modified first) and the secondary key being filename in the
collating sequence.
*
* This interface serves as an alias for the extended interface to simplify the
* command signature methods by avoiding generic parameters.
*/
public interface LsOptions extends OptionSet {
/**
* Constant for an empty option set.
*/
LsOptions EMPTY = new LsOptions() {
@Override
public Class optionType() {
return LsOption.class;
}
@Override
public boolean isSet(LsOption 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(LsOption option) {
return true;
}
};
/**
* Default implementation for a modifiable option set.
*/
class Default extends DefaultOptionSet implements LsOptions {
/**
* Default constructor for an empty option set with no active options.
*/
public Default() {
super(LsOption.class);
}
/**
* Constructor for an option set with a single active option.
* @param option the option to be set
*/
public Default(LsOption option) {
super(option);
}
/**
* Constructor for an option set with the given active options.
* @param options the options to be set
*/
public Default(LsOption... 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 LsOptions} based on an {@link OptionSetConverter}.
*/
ValueConverter CONVERTER = new ValueConverter() {
private final OptionSetConverter converter = new OptionSetConverter(LsOption.class);
@Override
public LsOptions convert(Object value) {
final OptionSet set = converter.convert(value);
return set == null ? null : new Default(set);
}
};
}