Coverage Report

Coverage Report - org.apache.commons.cli2.option.OptionImpl

Classes in this File

Line Coverage

Branch Coverage

Complexity

OptionImpl

90%

48/53

83%

30/36

2.786

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.apache.commons.cli2.option;
 
 import java.util.Iterator;
 import java.util.ListIterator;
 import java.util.Set;
 
 import org.apache.commons.cli2.DisplaySetting;
 import org.apache.commons.cli2.Option;
 import org.apache.commons.cli2.WriteableCommandLine;
 import org.apache.commons.cli2.resource.ResourceConstants;
 import org.apache.commons.cli2.resource.ResourceHelper;
 
 /**
  * A base implementation of Option providing limited ground work for further
  * Option implementations.
  */
 public abstract class OptionImpl implements Option {
     private final int id;
     private final boolean required;
     private Option parent;
 
     /**
      * Creates an OptionImpl with the specified id
      * @param id the unique id of this Option
      * @param required true iff this Option must be present
      */
     public OptionImpl(final int id,
                       final boolean required) {
         this.id = id;
         this.required = required;
     }
 
     public boolean canProcess(final WriteableCommandLine commandLine,
                               final ListIterator arguments) {
         if (arguments.hasNext()) {
             final String argument = (String) arguments.next();
             arguments.previous();
 
             return canProcess(commandLine, argument);
         } else {
             return false;
         }
     }
 
     public String toString() {
         final StringBuffer buffer = new StringBuffer();
         appendUsage(buffer, DisplaySetting.ALL, null);
 
         return buffer.toString();
     }
 
     public int getId() {
         return id;
     }
 
     public boolean equals(final Object thatObj) {
         if (thatObj instanceof OptionImpl) {
             final OptionImpl that = (OptionImpl) thatObj;
 
             return (getId() == that.getId()) &&
                    equals(getPreferredName(), that.getPreferredName()) &&
                    equals(getDescription(), that.getDescription()) &&
                    equals(getPrefixes(), that.getPrefixes()) &&
                    equals(getTriggers(), that.getTriggers());
         } else {
             return false;
         }
     }
 
     private boolean equals(Object left,
                            Object right) {
         if ((left == null) && (right == null)) {
             return true;
         } else if ((left == null) || (right == null)) {
             return false;
         } else {
             return left.equals(right);
         }
     }
 
     public int hashCode() {
         int hashCode = getId();
         if (getPreferredName() != null) {
             hashCode = (hashCode * 37) + getPreferredName().hashCode();
         }
 
         if (getDescription() != null) {
             hashCode = (hashCode * 37) + getDescription().hashCode();
         }
 
         hashCode = (hashCode * 37) + getPrefixes().hashCode();
         hashCode = (hashCode * 37) + getTriggers().hashCode();
 
         return hashCode;
     }
 
     public Option findOption(String trigger) {
         if (getTriggers().contains(trigger)) {
             return this;
         } else {
             return null;
         }
     }
 
     public boolean isRequired() {
         return required;
     }
 
     public void defaults(final WriteableCommandLine commandLine) {
         // nothing to do normally
     }
 
     public Option getParent() {
         return parent;
     }
 
     public void setParent(Option parent) {
         this.parent = parent;
     }
 
     protected void checkPrefixes(final Set prefixes) {
         // nothing to do if empty prefix list
         if (prefixes.isEmpty()) {
             return;
         }
 
         // check preferred name
         checkPrefix(prefixes, getPreferredName());
 
         // check triggers
         this.getTriggers();
 
         for (final Iterator i = getTriggers().iterator(); i.hasNext();) {
             checkPrefix(prefixes, (String) i.next());
         }
     }
 
     private void checkPrefix(final Set prefixes,
                              final String trigger) {
         for (final Iterator i = prefixes.iterator(); i.hasNext();) {
             String prefix = (String) i.next();
 
             if (trigger.startsWith(prefix)) {
                 return;
             }
         }
 
         final ResourceHelper helper = ResourceHelper.getResourceHelper();
         final String message =
             helper.getMessage(ResourceConstants.OPTION_TRIGGER_NEEDS_PREFIX, trigger,
                               prefixes.toString());
         throw new IllegalArgumentException(message);
     }
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one or more
3		* contributor license agreements. See the NOTICE file distributed with
4		* this work for additional information regarding copyright ownership.
5		* The ASF licenses this file to You under the Apache License, Version 2.0
6		* (the "License"); you may not use this file except in compliance with
7		* the License. You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17		package org.apache.commons.cli2.option;
18
19		import java.util.Iterator;
20		import java.util.ListIterator;
21		import java.util.Set;
22
23		import org.apache.commons.cli2.DisplaySetting;
24		import org.apache.commons.cli2.Option;
25		import org.apache.commons.cli2.WriteableCommandLine;
26		import org.apache.commons.cli2.resource.ResourceConstants;
27		import org.apache.commons.cli2.resource.ResourceHelper;
28
29		/**
30		* A base implementation of Option providing limited ground work for further
31		* Option implementations.
32		*/
33		public abstract class OptionImpl implements Option {
34		private final int id;
35		private final boolean required;
36		private Option parent;
37
38		/**
39		* Creates an OptionImpl with the specified id
40		* @param id the unique id of this Option
41		* @param required true iff this Option must be present
42		*/
43		public OptionImpl(final int id,
44	2153	final boolean required) {
45	2153	this.id = id;
46	2153	this.required = required;
47	2153	}
48
49		public boolean canProcess(final WriteableCommandLine commandLine,
50		final ListIterator arguments) {
51	174	if (arguments.hasNext()) {
52	103	final String argument = (String) arguments.next();
53	103	arguments.previous();
54
55	103	return canProcess(commandLine, argument);
56		} else {
57	71	return false;
58		}
59		}
60
61		public String toString() {
62	2	final StringBuffer buffer = new StringBuffer();
63	2	appendUsage(buffer, DisplaySetting.ALL, null);
64
65	2	return buffer.toString();
66		}
67
68		public int getId() {
69	7272	return id;
70		}
71
72		public boolean equals(final Object thatObj) {
73	2221	if (thatObj instanceof OptionImpl) {
74	2221	final OptionImpl that = (OptionImpl) thatObj;
75
76	2221	return (getId() == that.getId()) &&
77		equals(getPreferredName(), that.getPreferredName()) &&
78		equals(getDescription(), that.getDescription()) &&
79		equals(getPrefixes(), that.getPrefixes()) &&
80		equals(getTriggers(), that.getTriggers());
81		} else {
82	0	return false;
83		}
84		}
85
86		private boolean equals(Object left,
87		Object right) {
88	4294	if ((left == null) && (right == null)) {
89	693	return true;
90	3601	} else if ((left == null) \|\| (right == null)) {
91	423	return false;
92		} else {
93	3178	return left.equals(right);
94		}
95		}
96
97		public int hashCode() {
98	2823	int hashCode = getId();
99	2823	if (getPreferredName() != null) {
100	2823	hashCode = (hashCode * 37) + getPreferredName().hashCode();
101		}
102
103	2823	if (getDescription() != null) {
104	1078	hashCode = (hashCode * 37) + getDescription().hashCode();
105		}
106
107	2823	hashCode = (hashCode * 37) + getPrefixes().hashCode();
108	2823	hashCode = (hashCode * 37) + getTriggers().hashCode();
109
110	2823	return hashCode;
111		}
112
113		public Option findOption(String trigger) {
114	430	if (getTriggers().contains(trigger)) {
115	138	return this;
116		} else {
117	292	return null;
118		}
119		}
120
121		public boolean isRequired() {
122	637	return required;
123		}
124
125		public void defaults(final WriteableCommandLine commandLine) {
126		// nothing to do normally
127	396	}
128
129		public Option getParent() {
130	1034	return parent;
131		}
132
133		public void setParent(Option parent) {
134	1235	this.parent = parent;
135	1235	}
136
137		protected void checkPrefixes(final Set prefixes) {
138		// nothing to do if empty prefix list
139	1191	if (prefixes.isEmpty()) {
140	0	return;
141		}
142
143		// check preferred name
144	1191	checkPrefix(prefixes, getPreferredName());
145
146		// check triggers
147	1191	this.getTriggers();
148
149	1191	for (final Iterator i = getTriggers().iterator(); i.hasNext();) {
150	1784	checkPrefix(prefixes, (String) i.next());
151		}
152	1191	}
153
154		private void checkPrefix(final Set prefixes,
155		final String trigger) {
156	2975	for (final Iterator i = prefixes.iterator(); i.hasNext();) {
157	3721	String prefix = (String) i.next();
158
159	3721	if (trigger.startsWith(prefix)) {
160	2975	return;
161		}
162	746	}
163
164	0	final ResourceHelper helper = ResourceHelper.getResourceHelper();
165	0	final String message =
166		helper.getMessage(ResourceConstants.OPTION_TRIGGER_NEEDS_PREFIX, trigger,
167		prefixes.toString());
168	0	throw new IllegalArgumentException(message);
169		}
170		}