UsageHelper


1   /*====================================================================
2   
3   ObjectWeb Util CommandLine Package.
4   Copyright (C) 2003 INRIA & USTL - LIFL - GOAL
5   Contact: architecture@objectweb.org
6   
7   This library is free software; you can redistribute it and/or
8   modify it under the terms of the GNU Lesser General Public
9   License as published by the Free Software Foundation; either
10  version 2.1 of the License, or any later version.
11  
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  Lesser General Public License for more details.
16  
17  You should have received a copy of the GNU Lesser General Public
18  License along with this library; if not, write to the Free Software
19  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
20  USA
21  
22  Initial developer(s): Philippe Merle.
23  Contributor(s): ______________________________________.
24  
25  ====================================================================*/
26  
27  package org.objectweb.util.cmdline.lib;
28  
29  import org.objectweb.util.misc.lib.StringBufferHelper;
30  
31  import org.objectweb.util.cmdline.api.Usage;
32  
33  /**
34   * Some helper functions for the interface
35   * org.objectweb.util.cmdline.api.Usage.
36   *
37   * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
38   *
39   * @version 0.1
40   */
41  
42  public abstract class UsageHelper
43  {
44      // ==================================================================
45      //
46      // Internal state.
47      //
48      // ==================================================================
49  
50      // ==================================================================
51      //
52      // Constructors.
53      //
54      // ==================================================================
55  
56      // ==================================================================
57      //
58      // Internal methods.
59      //
60      // ==================================================================
61  
62      // ==================================================================
63      //
64      // Static public methods.
65      //
66      // ==================================================================
67  
68      /**
69       * Gets the given usage labels as string.
70       *
71       * @param usage The given usage.
72       * @param separator The given separator.
73       *
74       * @return The usage labels as string.
75       */
76      static public String  
77      usageLabelsAsString(Usage usage,
78                          String   separator)
79      {
80          StringBuffer   sb = new StringBuffer  ();
81          StringBufferHelper.append(sb, usage.getLabels(), separator);
82          return sb.toString();
83      }
84  
85      /**
86       * Gets the given usage arguments as string.
87       *
88       * @param usage The given usage.
89       * @param separator The given separator.
90       *
91       * @return The usage arguments as string.
92       */
93      static public String  
94      usageArgumentsAsString(Usage usage,
95                             String   separator)
96      {
97          StringBuffer   sb = new StringBuffer  ();
98          StringBufferHelper.append(sb, usage.getArguments(), separator);
99          return sb.toString();
100     }
101 
102     /**
103      * Gets the given usage description as string.
104      *
105      * @param usage The given usage.
106      * @param separator The given separator.
107      *
108      * @return The usage description as string.
109      */
110     static public String  
111     usageDescriptionAsString(Usage usage,
112                              String   separator)
113     {
114         StringBuffer   sb = new StringBuffer  ();
115         StringBufferHelper.append(sb, usage.getDescription(), separator);
116         return sb.toString();
117     }
118 
119     // ==================================================================
120     //
121     // Other public methods.
122     //
123     // ==================================================================
124 }
125
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags