Merge pull request #451 from metafacture/metafacture-documentation-19-markDeprecatedFluxCommandOptions

Mark deprecated Flux command options in help output.

Author: blackwinter

metafacture-commons/src/main/java/org/metafacture/commons/reflection/ConfigurableClass.java

@@ -98,16 +98,25 @@ private boolean isSetter(final Method method) {
         return false;
     }
 
+    /**
+     * Gets the parameter type of the setter method.
+     *
+     * @param method the setter method
+     * @return the type
+     */
+    public Class<?> getSetterType(final Method method) {
+        return method.getParameterTypes()[0];
+    }
+
     /**
      * Gets the parameter types of the setter methods.
      *
      * @return a Map of the setter method names and their types
      */
     public Map<String, Class<?>> getSetterTypes() {
         final Map<String, Class<?>> setterTypes = new HashMap<>();
-        for (final Map.Entry<String, Method> method : getSetters().entrySet()) {
-            final Class<?> setterType = method.getValue().getParameterTypes()[0];
-            setterTypes.put(method.getKey(), setterType);
+        for (final Map.Entry<String, Method> entry : getSetters().entrySet()) {
+            setterTypes.put(entry.getKey(), getSetterType(entry.getValue()));
         }
         return setterTypes;
     }

metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinter.java

@@ -17,6 +17,7 @@
 package org.metafacture.flux;
 
 import org.metafacture.commons.ResourceUtil;
+import org.metafacture.commons.reflection.ConfigurableClass;
 import org.metafacture.commons.reflection.ObjectFactory;
 import org.metafacture.framework.MetafactureException;
 import org.metafacture.framework.annotations.Description;
@@ -80,8 +81,9 @@ private static String getVersionInfo() {
         }
     }
 
-    private static <T> void describe(final String name, final ObjectFactory<T> factory, final PrintStream out) {
-        final Class<? extends T> moduleClass = factory.get(name).getPlainClass();
+    private static <T> void describe(final String name, final ObjectFactory<T> factory, final PrintStream out) { // checkstyle-disable-line ExecutableStatementCount
+        final ConfigurableClass<? extends T> configurableClass = factory.get(name);
+        final Class<? extends T> moduleClass = configurableClass.getPlainClass();
         final Description desc = moduleClass.getAnnotation(Description.class);
 
         out.println(name);
@@ -96,22 +98,29 @@ private static <T> void describe(final String name, final ObjectFactory<T> facto
             out.println("- arguments:\t" + arguments);
         }
 
-        final Map<String, Class<?>> attributes = factory.get(name).getSetterTypes();
+        final Map<String, Method> attributes = configurableClass.getSetters();
 
         if (!attributes.isEmpty()) {
             out.print("- options:\t");
             final StringBuilder builder = new StringBuilder();
-            for (final Entry<String, Class<?>> entry : attributes.entrySet()) {
-                if (entry.getValue().isEnum()) {
+            for (final Entry<String, Method> entry : attributes.entrySet()) {
+                final Method method = entry.getValue();
+                final Class<?> type = configurableClass.getSetterType(method);
+
+                if (method.isAnnotationPresent(Deprecated.class)) {
+                    builder.append("[deprecated] ");
+                }
+
+                if (type.isEnum()) {
                     builder.append(entry.getKey())
                             .append(" ")
-                            .append(Arrays.asList(entry.getValue().getEnumConstants()))
+                            .append(Arrays.asList(type.getEnumConstants()))
                             .append(", ");
                 }
                 else {
                     builder.append(entry.getKey())
                             .append(" (")
-                            .append(entry.getValue().getSimpleName())
+                            .append(type.getSimpleName())
                             .append("), ");
                 }
 

metafacture-yaml/src/main/java/org/metafacture/yaml/YamlEncoder.java

@@ -46,7 +46,7 @@
  * @author Jens Wille
  *
  */
-@Description("Serialises an object as YAML. The paramter 'prettyprinting (boolean)' is deprecated since it's not possible to not pretty print.")
+@Description("Serialises an object as YAML.")
 @In(StreamReceiver.class)
 @Out(String.class)
 @FluxCommand("encode-yaml")