View Javadoc

1   /*
2    * $Source: /usr/cvsroot/melati/maven-dsd-plugin/src/main/java/org/melati/poem/prepro/StringUtils.java,v $
3    * $Revision: 1.1 $
4    *
5    * Copyright (C) 2000 William Chesters
6    *
7    * Part of Melati (http://melati.org), a framework for the rapid
8    * development of clean, maintainable web applications.
9    *
10   * Melati is free software; Permission is granted to copy, distribute
11   * and/or modify this software under the terms either:
12   *
13   * a) the GNU General Public License as published by the Free Software
14   *    Foundation; either version 2 of the License, or (at your option)
15   *    any later version,
16   *
17   *    or
18   *
19   * b) any version of the Melati Software License, as published
20   *    at http://melati.org
21   *
22   * You should have received a copy of the GNU General Public License and
23   * the Melati Software License along with this program;
24   * if not, write to the Free Software Foundation, Inc.,
25   * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26   * GNU General Public License and visit http://melati.org to obtain the
27   * Melati Software License.
28   *
29   * Feel free to contact the Developers of Melati (http://melati.org),
30   * if you would like to work out a different arrangement than the options
31   * outlined here.  It is our intention to allow Melati to be used by as
32   * wide an audience as possible.
33   *
34   * This program is distributed in the hope that it will be useful,
35   * but WITHOUT ANY WARRANTY; without even the implied warranty of
36   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
37   * GNU General Public License for more details.
38   *
39   * Contact details for copyright holder:
40   *
41   *     William Chesters <williamc At paneris.org>
42   *     http://paneris.org/~williamc
43   *     Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44   */
45  
46  package org.melati.poem.prepro;
47  
48  /**
49   * An assortment of useful operations on <code>String</code>s.
50   *
51   */
52  public final class StringUtils {
53  
54    private StringUtils() {}
55  
56  
57    /**
58     * Append a String to a StringBuffer, first quoting it with a quote
59     * character and escaping any occurances of the quote char in the String.
60     *
61     * @param b the buffer to append to
62     * @param s the String to append
63     * @param q the quote character
64     */
65    public static void appendQuoted(StringBuffer b, String s, char q) {
66      b.append(q);
67      appendEscaped(b, s, q);
68      b.append(q);
69    }
70  
71    /**
72     * Surround a string in quotes.
73     *
74     * @param i the string to quote
75     * @param q The quote character to use
76     * @return the quoted string
77     */
78    public static String quoted(String i, char q) {
79      StringBuffer b = new StringBuffer();
80      appendQuoted(b, i, q);
81      return b.toString();
82    }
83  
84    /**
85     * Append a String to a StringBuffer, and escaping any occurances
86     * of the char in the String.
87     *
88     * @param b the buffer to append to
89     * @param s the String to append
90     * @param e the character to escape
91     */
92    public static void appendEscaped(StringBuffer b, String s, char e) {
93      int l = s.length();
94      for (int i = 0; i < l; ++i) {
95        char c = s.charAt(i);
96        if (c == '\\' || c == e) {
97          // damn, found one; catch up to here ...
98  
99          for (int j = 0; j < i; ++j)
100           b.append(s.charAt(j));
101         b.append('\\');
102         b.append(c);
103 
104         // ... and continue
105 
106         for (++i; i < l; ++i) {
107           c = s.charAt(i);
108           if (c == '\\' || c == e)
109             b.append('\\');
110           b.append(c);
111         }
112 
113         return;
114       }
115     }
116 
117     b.append(s);
118   }
119 
120   /**
121    * Captialise the first character of the input string.
122    *
123    * @param name
124    * @return the capitalised string
125    */
126   public static String capitalised(String name) {
127     char suffix[] = name.toCharArray();
128     suffix[0] = Character.toUpperCase(suffix[0]);
129     return new String(suffix);
130   }
131 
132 }