001package org.unix4j.unix.echo;
002
003import org.unix4j.unix.Echo;
004
005/**
006 * Options for the {@link Echo echo} command with the 
007 * the following options: 
008 * <p>
009 * <table>
010 * <tr valign="top"><td width="10px"></td><td nowrap="nowrap">{@code -n}</td><td>&nbsp;&nbsp;</td><td nowrap="nowrap">{@code --noNewline}</td><td>&nbsp;</td><td>Do not print the trailing newline character(s).</td></tr>
011 * </table>
012 * <p>
013 * This class serves as entry point to every possible set of {@code echo} options
014 * defined as an enum constant. With this explicit expansion of all possible 
015 * option combinations, options can be passed to the command in a very compact 
016 * form, such as:
017 * <pre>
018 * echo(Echo.Options.n, ...);
019 * </pre>
020 */
021public final class EchoOptionSets {
022        /**
023         * The singleton instance.
024         */
025        public static final EchoOptionSets INSTANCE = new EchoOptionSets();
026        
027        /**
028         * Option {@code "-n"}: Do not print the trailing newline character(s).
029         * <p>
030         * The option {@code "-n"} is equivalent to the {@code "--}{@link #noNewline noNewline}{@code "} option.
031         */
032        public final EchoOptionSet_n n = EchoOptionSet_n.Active_n;  
033        /**
034         * Option {@code "--noNewline"}: Do not print the trailing newline character(s).
035         * <p>
036         * The option {@code "--noNewline"} is equivalent to the {@code "-}{@link #n n}{@code "} option.
037         */
038        public final EchoOptionSet_n noNewline = EchoOptionSet_n.Active_n_long;  
039        
040}