[Jnode-svn-commits] SF.net SVN: jnode: [3895] trunk/shell/src/shell/org/jnode/shell/syntax/ EmptySyntax.java

[<cr...@us...>]

Revision: 3895
          http://jnode.svn.sourceforge.net/jnode/?rev=3895&view=rev
Author:   crawley
Date:     2008-03-28 08:08:06 -0700 (Fri, 28 Mar 2008)

Log Message:
-----------
Correct format method and add javadocs

Modified Paths:
--------------
    trunk/shell/src/shell/org/jnode/shell/syntax/EmptySyntax.java

Modified: trunk/shell/src/shell/org/jnode/shell/syntax/EmptySyntax.java
===================================================================
--- trunk/shell/src/shell/org/jnode/shell/syntax/EmptySyntax.java	2008-03-28 15:06:44 UTC (rev 3894)
+++ trunk/shell/src/shell/org/jnode/shell/syntax/EmptySyntax.java	2008-03-28 15:08:06 UTC (rev 3895)
@@ -21,6 +21,14 @@
 
 package org.jnode.shell.syntax;
 
+/**
+ * This class provides a way of representing an empty syntax or syntax alternative; e.g. when
+ * a command or command variant takes no options or arguments.  An EmptySyntax allows you to
+ * attach a description or a syntax label, something that cannot be done when the empty alternative
+ * is represented by a <code>null</code>.
+ * 
+ * @author cr...@jn...
+ */
 public class EmptySyntax extends Syntax {
     
     public EmptySyntax(String label, String description) {
@@ -29,7 +37,7 @@
     
     @Override
     public String format(ArgumentBundle bundle) {
-        return "<empty>";
+        return "";
     }
 
     @Override


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.