01: /*
02: Copyright 2004-2007 Paul R. Holser, Jr. All rights reserved.
03: Licensed under the Academic Free License version 3.0
04: */
05:
06: package joptsimple;
07:
08: /**
09: * <p>Superclass of exceptions thrown by the option parsing classes.</p>
10: *
11: * @since 1.0
12: * @author <a href="mailto:pholser@alumni.rice.edu">Paul Holser</a>
13: * @version $Id: OptionException.java,v 1.12 2007/04/10 20:06:24 pholser Exp $
14: */
15: public abstract class OptionException extends RuntimeException {
16: private final String option;
17:
18: /**
19: * Creates and initializes an exception.
20: *
21: * @param option the option being considered when the exception was created
22: */
23: protected OptionException(String option) {
24: this .option = option;
25: }
26:
27: /**
28: * Gives the option being considered when the exception was created.
29: *
30: * @since 2.1
31: * @return the option being considered when the exception was created
32: */
33: public String option() {
34: return option;
35: }
36:
37: /**
38: * {@inheritDoc}
39: */
40: public String toString() {
41: return super .toString() + ": '" + option + '\'';
42: }
43: }
|