View Javadoc

1   /*
2    * $Source$
3    * $Revision$
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   *     Tim Pizey <timp At paneris.org>
42   *     http://paneris.org/~timp
43   */
44  
45  package org.melati.template;
46  
47  import java.io.IOException;
48  
49  import org.melati.poem.AccessPoemException;
50  import org.melati.util.MelatiWriter;
51  
52  /**
53   * A MarkupLanguage suitable for markup within an attribute tag.
54   * @since 17-May-2006
55   */
56  public interface AttributeMarkupLanguage extends MarkupLanguage {
57  
58    /**
59     * AccessPoemException is treated differently in an Atribute than 
60     * in the main body of a page.
61     * @param e an Exception to render
62     * @return a String representation of the Exception
63     */
64    String rendered(AccessPoemException e) throws IOException;
65  
66    /**
67     * Render, not translating line ends to BR tags.
68     * 
69     * @param s the String to render
70     * @param writer writer to render to 
71     * @see org.melati.template.AbstractMarkupLanguage#render(String, MelatiWriter)
72     */
73    void render(String s, MelatiWriter writer) throws IOException;
74  
75  }
76  
77