Added findbugs to the build

ziccardi · ziccardi · commit 16d13842fa90 · 2017-01-11T17:11:09.000Z
Added comments
diff --git a/pom.xml b/pom.xml
@@ -26,4 +26,30 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>findbugs-maven-plugin</artifactId>
+                <version>3.0.4</version>
+                <configuration>
+                    <effort>Max</effort>
+                    <threshold>Low</threshold>
+                    <xmlOutput>true</xmlOutput>
+                    <failOnError>false</failOnError>
+                    <findbugsXmlOutputDirectory>${project.build.directory}/findbugs</findbugsXmlOutputDirectory>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>analyze-compile</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>
diff --git a/src/main/java/it/jnrpe/yaclp/Argument.java b/src/main/java/it/jnrpe/yaclp/Argument.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
 import java.util.List;
diff --git a/src/main/java/it/jnrpe/yaclp/ArgumentBuilder.java b/src/main/java/it/jnrpe/yaclp/ArgumentBuilder.java
@@ -1,5 +1,23 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
+/**
+ * Builds an argument parser.
+ */
 public class ArgumentBuilder {
     private final String name;
     private boolean mandatory = true;
@@ -8,15 +26,29 @@ private ArgumentBuilder(final String name) {
         this.name = name;
     }
 
+    /**
+     * Returns an instance of the builder for an argument with the given name.
+     * @param name the name of the argument
+     * @return the builder
+     */
     public static ArgumentBuilder forArgument(final String name) {
         return new ArgumentBuilder(name);
     }
 
-    public ArgumentBuilder mandatory(boolean mandatory) {
+    /**
+     * Whether the argument is mandatory or not
+     * @param mandatory Whether the argument is mandatory or not
+     * @return the builder
+     */
+    public ArgumentBuilder mandatory(final boolean mandatory) {
         this.mandatory = mandatory;
         return this;
     }
 
+    /**
+     * Builds the argument with the provided options.
+     * @return the newly build argument
+     */
     public IArgument build() {
         return new Argument(name, mandatory);
     }
diff --git a/src/main/java/it/jnrpe/yaclp/CommandLine.java b/src/main/java/it/jnrpe/yaclp/CommandLine.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
 import java.util.ArrayList;
diff --git a/src/main/java/it/jnrpe/yaclp/HelpFormatter.java b/src/main/java/it/jnrpe/yaclp/HelpFormatter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
 import it.jnrpe.yaclp.help.OptionHelpFormatter;
@@ -6,6 +21,9 @@
 import java.io.PrintStream;
 import java.util.List;
 
+/**
+ * Utility class for providing help info.
+ */
 public class HelpFormatter {
 
     private final String appName;
@@ -51,9 +69,6 @@ private int getOptionLength(IOption opt) {
     }
 
     private String formatUsage() {
-        StringBuilder usage = new StringBuilder(appName)
-            .append(" ");
-
         List<IOption> options = parser.getOptions();
         String[] opts = new String[options.size()];
         for (int i = 0; i < opts.length; i++) {
diff --git a/src/main/java/it/jnrpe/yaclp/IArgument.java b/src/main/java/it/jnrpe/yaclp/IArgument.java
@@ -1,8 +1,20 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
-/**
- * Created by ziccardi on 11/01/2017.
- */
 public interface IArgument {
     String getName();
 }
diff --git a/src/main/java/it/jnrpe/yaclp/IOption.java b/src/main/java/it/jnrpe/yaclp/IOption.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
 import java.util.List;
diff --git a/src/main/java/it/jnrpe/yaclp/MutuallyExclusiveOptionBuilder.java b/src/main/java/it/jnrpe/yaclp/MutuallyExclusiveOptionBuilder.java
@@ -1,10 +1,25 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Created by ziccardi on 11/01/2017.
+ * Builder for mutually exclusive options
  */
 public class MutuallyExclusiveOptionBuilder {
     private List<IOption> options = new ArrayList<IOption>();
@@ -14,21 +29,40 @@ public class MutuallyExclusiveOptionBuilder {
     MutuallyExclusiveOptionBuilder() {
     }
 
+    /**
+     * Call this method many time to add all the options than can't be specified together.
+     * @param option the option
+     * @return the builder
+     */
     public MutuallyExclusiveOptionBuilder withOption(final IOption option) {
         this.options.add(option);
         return this;
     }
 
+    /**
+     * If mandatory, one of the option MUST be present in the command line
+     * @param mandatory whether the option is mandatory or not
+     * @return the builder
+     */
     public MutuallyExclusiveOptionBuilder mandatory(boolean mandatory) {
         this.mandatory = mandatory;
         return this;
     }
 
+    /**
+     * Description for this mutually exlusive option group.
+     * @param description the description
+     * @return the builder
+     */
     public MutuallyExclusiveOptionBuilder description(final String description) {
         this.description = description;
         return this;
     }
 
+    /**
+     * Builds the option as configured.
+     * @return the newly build option
+     */
     public IOption build() {
         MutuallyExclusiveOptions opt = new MutuallyExclusiveOptions(options.toArray(new IOption[options.size()]));
         opt.setMandatory(mandatory);
diff --git a/src/main/java/it/jnrpe/yaclp/MutuallyExclusiveOptions.java b/src/main/java/it/jnrpe/yaclp/MutuallyExclusiveOptions.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
 import org.apache.commons.lang.StringUtils;
diff --git a/src/main/java/it/jnrpe/yaclp/Option.java b/src/main/java/it/jnrpe/yaclp/Option.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
 import java.util.ArrayList;
diff --git a/src/main/java/it/jnrpe/yaclp/OptionBuilder.java b/src/main/java/it/jnrpe/yaclp/OptionBuilder.java
@@ -1,5 +1,23 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Massimiliano Ziccardi
+ *
+ * Licensed 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 it.jnrpe.yaclp;
 
+/**
+ * Entry point for option builders.
+ */
 public class OptionBuilder {
 
     public static SimpleOptionBuilder forOption(final String shortName, final String longName){
diff --git a/src/main/java/it/jnrpe/yaclp/Parser.java b/src/main/java/it/jnrpe/yaclp/Parser.java
diff --git a/src/main/java/it/jnrpe/yaclp/ParsingException.java b/src/main/java/it/jnrpe/yaclp/ParsingException.java
diff --git a/src/main/java/it/jnrpe/yaclp/SimpleOptionBuilder.java b/src/main/java/it/jnrpe/yaclp/SimpleOptionBuilder.java
