IntegerOption.java

/*******************************************************************************
 * Copyright (c) 2004, 2013 Steve Flasby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * <ul>
 *     <li>Redistributions of source code must retain the above copyright notice,
 *         this list of conditions and the following disclaimer.</li>
 *     <li>Redistributions in binary form must reproduce the above copyright notice,
 *         this list of conditions and the following disclaimer in the documentation
 *         and/or other materials provided with the distribution.</li>
 * </ul>
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/
/*
* Created on 05-Nov-2004
*/
package org.flasby.cli;

/**
* adaptor to get an Integer from a commandline option.
* <pre> 
* {@code
* IntegerOption size = new IntegerOption( options.create( 's', "size", true ));
* CommandLine cmd = parser.parse(...); Integer s = size.getIntegerValue( cmd );
* } </pre>
* If this is derived from an optional argument, then it will provide the default value
* if one is defined. Otherwise it will reeturn null.
*
* @author Steve Flasby 05-Nov-2004
*/
public class IntegerOption {
   private final Option mOpt;

   public IntegerOption(Option opt) {
       mOpt = opt;
   }

   public Integer getIntegerValue(CommandLine commandLine) throws InvalidOptionFormatException {
       String s = commandLine.getValue(mOpt);
       if ( s==null ) {
           // Need to check if its optional...
           if ( mOpt.isMandatory() ) {
               throw new RuntimeException("Coding error, the option "+mOpt.toString()+" was mandatory but you managed to ask for its value as an Integer");
           }
           s = mOpt.getDefaultValue();
           if ( s==null ) {
               return null;
           }
       }
       try {
           return Integer.parseInt(s);
       } catch (NumberFormatException ex) {
           throw new InvalidOptionFormatException(commandLine.getOptions(), mOpt, s);
       }
   }

}