You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@oodt.apache.org by bf...@apache.org on 2011/12/04 21:40:12 UTC

svn commit: r1210206 - in /oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli: action/CmdLineAction.java printer/StdCmdLinePrinter.java

Author: bfoster
Date: Sun Dec  4 20:40:11 2011
New Revision: 1210206

URL: http://svn.apache.org/viewvc?rev=1210206&view=rev
Log:
-  changed needed for Action examples

-------------
OODT-360

Modified:
    oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/action/CmdLineAction.java
    oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/printer/StdCmdLinePrinter.java

Modified: oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/action/CmdLineAction.java
URL: http://svn.apache.org/viewvc/oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/action/CmdLineAction.java?rev=1210206&r1=1210205&r2=1210206&view=diff
==============================================================================
--- oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/action/CmdLineAction.java (original)
+++ oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/action/CmdLineAction.java Sun Dec  4 20:40:11 2011
@@ -36,7 +36,7 @@ public abstract class CmdLineAction {
    private String name;
    private String description;
    private String detailedDescription;
-   private List<Example> examples;
+   private String examples;
 
    public CmdLineAction() {
    }
@@ -70,11 +70,11 @@ public abstract class CmdLineAction {
       return detailedDescription;
    }
 
-   public void setExamples(List<Example> examples) {
+   public void setExamples(String examples) {
       this.examples = examples;
    }
 
-   public List<Example> getExamples() {
+   public String getExamples() {
       return examples;
    }
 
@@ -105,22 +105,4 @@ public abstract class CmdLineAction {
          return messages;
       }
    }
-
-   public static class Example {
-      private String description;
-      private String example;
-
-      public Example(String description, String example) {
-         this.description = description;
-         this.example = example;
-      }
-
-      public String getDescription() {
-         return description;
-      }
-
-      public String getExample() {
-         return example;
-      }
-   }
 }

Modified: oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/printer/StdCmdLinePrinter.java
URL: http://svn.apache.org/viewvc/oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/printer/StdCmdLinePrinter.java?rev=1210206&r1=1210205&r2=1210206&view=diff
==============================================================================
--- oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/printer/StdCmdLinePrinter.java (original)
+++ oodt/trunk/cli/src/main/java/org/apache/oodt/cas/cli/printer/StdCmdLinePrinter.java Sun Dec  4 20:40:11 2011
@@ -36,7 +36,6 @@ import org.apache.commons.lang.StringUti
 
 //OODT imports
 import org.apache.oodt.cas.cli.action.CmdLineAction;
-import org.apache.oodt.cas.cli.action.CmdLineAction.Example;
 import org.apache.oodt.cas.cli.option.ActionCmdLineOption;
 import org.apache.oodt.cas.cli.option.AdvancedCmdLineOption;
 import org.apache.oodt.cas.cli.option.CmdLineOption;
@@ -71,11 +70,14 @@ public class StdCmdLinePrinter implement
    }
 
    protected String getDescription(CmdLineAction action) {
-      StringBuffer sb = new StringBuffer("DESCRIPTION:\n");
+      StringBuffer sb = new StringBuffer("> DESCRIPTION:\n");
       if (action.getDetailedDescription() != null) {
-         sb.append(action.getDetailedDescription());
-      } else if (action.getDescription() != null){
-         sb.append(" ").append(action.getDescription());
+         sb.append(" ").append(action.getDetailedDescription()
+               .replaceAll("^\\s*", "").replaceAll("\\s*$", ""));
+      } else if (action.getDescription() != null) {
+         sb.append(" ").append(
+               action.getDescription().replaceAll("^\\s*", "")
+                     .replaceAll("\\s*$", ""));
       } else {
          sb.append(" - N/A");
       }
@@ -83,7 +85,7 @@ public class StdCmdLinePrinter implement
    }
 
    protected String getUsage(CmdLineAction action, Set<CmdLineOption> options) {
-      StringBuffer sb = new StringBuffer("USAGE:\n");
+      StringBuffer sb = new StringBuffer("> USAGE:\n");
       sb.append(getRequiredSubHeader()).append("\n");
       Set<CmdLineOption> requiredOptions = determineRequired(action, options);
       List<CmdLineOption> sortedRequiredOptions = sortOptionsByRequiredStatus(requiredOptions);
@@ -107,9 +109,9 @@ public class StdCmdLinePrinter implement
    protected String getRequiredOptionHelp(CmdLineAction action,
          CmdLineOption option) {
       if (option instanceof GroupCmdLineOption) {
-         return getGroupHelp(action, (GroupCmdLineOption) option, "    ");
+         return getGroupHelp(action, (GroupCmdLineOption) option, "   ");
       } else {
-         return getOptionHelp(action, option, "  ");
+         return getOptionHelp(action, option, "   ");
       }
    }
 
@@ -120,19 +122,17 @@ public class StdCmdLinePrinter implement
    protected String getOptionalOptionHelp(CmdLineAction action,
          CmdLineOption option) {
       if (option instanceof GroupCmdLineOption) {
-         return getGroupHelp(action, (GroupCmdLineOption) option, "    ");
+         return getGroupHelp(action, (GroupCmdLineOption) option, "   ");
       } else {
-         return getOptionHelp(action, option, "  ");
+         return getOptionHelp(action, option, "   ");
       }
    }
 
    protected String getExamples(CmdLineAction action) {
-      StringBuffer sb = new StringBuffer("EXAMPLES:\n");
-      if (action.getExamples() != null && !action.getExamples().isEmpty()) {
-         for (Example example : action.getExamples()) {
-            sb.append(example.getDescription()).append("\n");
-            sb.append(" - ").append(example.getExample()).append("\n");
-         }
+      StringBuffer sb = new StringBuffer("> EXAMPLES:\n");
+      if (action.getExamples() != null) {
+         sb.append(" ").append(action.getExamples().replaceAll("^\\s*", "")
+               .replaceAll("\\s*$", ""));
       } else {
          sb.append(" - N/A");
       }
@@ -234,10 +234,12 @@ public class StdCmdLinePrinter implement
    protected String getOptionHelp(CmdLineOption option, String indent) {
       String argName = option.hasArgs() ? " <" + option.getArgsDescription()
             + ">" : "";
-      String optionUsage = indent + "-"
-            + StringUtils.rightPad(option.getShortOption() + ",", 7) + "--"
-            + StringUtils.rightPad((option.getLongOption() + argName), 49 - indent.length())
-            + option.getDescription();
+      String optionUsage = indent
+            + "-"
+            + StringUtils.rightPad(option.getShortOption() + ",", 7)
+            + "--"
+            + StringUtils.rightPad((option.getLongOption() + argName),
+                  49 - indent.length()) + option.getDescription();
 
       optionUsage = " " + optionUsage;
 
@@ -260,7 +262,7 @@ public class StdCmdLinePrinter implement
          optionUsage += "\n";
          optionUsage += "   SubOptions:\n";
          optionUsage += "   > Required:\n";
-         
+
          List<CmdLineOption> optionalOptions = Lists.newArrayList();
          for (GroupSubOption subOption : groupOption.getSubOptions()) {
             if (subOption.isRequired()) {