PrettyString


1   /*
2     * JBoss, Home of Professional Open Source
3     * Copyright 2005, JBoss Inc., and individual contributors as indicated
4     * by the @authors tag. See the copyright.txt in the distribution for a
5     * full listing of individual contributors.
6     *
7     * This is free software; you can redistribute it and/or modify it
8     * under the terms of the GNU Lesser General Public License as
9     * published by the Free Software Foundation; either version 2.1 of
10    * the License, or (at your option) any later version.
11    *
12    * This software 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 software; if not, write to the Free
19    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21    */
22  package org.jboss.util;
23  
24  /**
25   * A simple interface for objects that can return pretty (ie.
26   * prefixed) string representations of themselves.
27   *
28   * @version <tt>$Revision: 1958 $</tt>
29   * @author  <a HREF="mailto:jason@planet57.com">Jason Dillon</a>
30   */
31  public interface PrettyString
32  {
33     /**
34      * Returns a pretty representation of the object.
35      *
36      * @param prefix  The string which all lines of the output must be prefixed with.
37      * @return        A pretty representation of the object.
38      */
39     String   toPrettyString(String   prefix);
40  
41     /**
42      * Interface for appending the objects pretty string onto a buffer.
43      */
44     interface Appendable
45     {
46        /**
47         * Appends a pretty representation of the object to the given buffer.
48         *
49         * @param buff    The buffer to use while making pretty.
50         * @param prefix  The string which all lines of the output must be prefixed with.
51         * @return        The buffer.
52         */
53        StringBuffer   appendPrettyString(StringBuffer   buff, String   prefix);
54     }
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags