UnknownArgumentException.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 16-Jul-2004
 *
 */
package org.flasby.cli;

/**
 * @author flasbyst
 *
 */
public class UnknownArgumentException extends OptionException {
	/**
	 * Comment for <code>serialVersionUID</code>
	 */
	private static final long serialVersionUID = 9000943172961684188L;
	
	
	private final String mUnknownArgument;
	public UnknownArgumentException( String unknownArgument, Options options ) {
		super( options );
		mUnknownArgument = unknownArgument;
	}
	public String getUnknownArgument() {
		return mUnknownArgument;
	}
	/**
	 * returns a localised message using an MLS key defined as
	 * the options mls key with "unknown" appended. This message
	 * should have a single parameter {0} which will be replaced by
	 * the unknown argument.
	 * For example: org.flasby.beantest.unknown=Unknown argument ''{0}''
	 */
	@Override
	public String getLocalizedMessage(){
		return getOptions().getMessageBundle().getMLS(getOptions().getMlsKey("unknown"), mUnknownArgument );
	}
	@Override
	public Option getOption() {
		return new Option() {
			
			@Override
			public boolean isMandatory() {
				return false;
			}
			
			@Override
			public String getOpt() {
				return mUnknownArgument;
			}
			
			@Override
			public String getDescriptionKey() {
				return "unknown.option";
			}
			
			@Override
			public String getDefaultValue() {
				return null;
			}
		};
//		return getOptions().create("unknown.option");
	}

}