CLIOptions.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2022 Marco Foscato <marco.foscato@uib.no>
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.main;
 
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
 
import denoptim.constants.DENOPTIMConstants;
import denoptim.main.Main.RunType;
 
public class CLIOptions extends Options
{
    private static final long serialVersionUID = 3L;
    
    public static Option help;
    
    public static Option version;
    
    public static Option run;
    
    private static final CLIOptions instance = new CLIOptions();
    
//------------------------------------------------------------------------------    
    
    private CLIOptions() 
    {
        help = new Option("h","help",false, "Print help message.");
        help.setRequired(false);
        this.addOption(help);
        
        run = new Option("r","run",true, "Request a specific type of "
                + "run. Choose among:" + DENOPTIMConstants.EOL
                + RunType.getRunTypesForUser() + DENOPTIMConstants.EOL
                + "When using -r, an input parameter file (e.g., input.params) "
                + "must be specified as an additional argument.");
        run.setRequired(false);
        this.addOption(run);
        
        version = new Option("v","version",false, "Print denoptim version.");
        version.setRequired(false);
        this.addOption(version);
    }
    
//------------------------------------------------------------------------------
    
    public static CLIOptions getInstance()
    {
        return instance;
    }
    
//------------------------------------------------------------------------------
    
}