1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package javax.faces.context;
20
21 import javax.faces.component.UIComponent;
22 import java.io.IOException;
23 import java.io.Writer;
24
25 /**
26 * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
27 *
28 * @author Manfred Geiler (latest modification by $Author: skitching $)
29 * @version $Revision: 676298 $ $Date: 2008-07-13 05:31:48 -0500 (Sun, 13 Jul 2008) $
30 */
31 public abstract class ResponseWriter
32 extends Writer
33 {
34 public abstract String getContentType();
35
36 public abstract String getCharacterEncoding();
37
38 public abstract void flush()
39 throws IOException;
40
41 public abstract void startDocument()
42 throws IOException;
43
44 public abstract void endDocument()
45 throws IOException;
46
47 public abstract void startElement(String name,
48 UIComponent component)
49 throws IOException;
50
51 public abstract void endElement(String name)
52 throws IOException;
53
54 public abstract void writeAttribute(String name,
55 Object value,
56 String property)
57 throws IOException;
58
59 public abstract void writeURIAttribute(String name,
60 Object value,
61 String property)
62 throws IOException;
63
64 public abstract void writeComment(Object comment)
65 throws IOException;
66
67 public abstract void writeText(Object text,
68 String property)
69 throws IOException;
70
71 public abstract void writeText(char[] text,
72 int off,
73 int len)
74 throws IOException;
75
76 public abstract ResponseWriter cloneWithWriter(Writer writer);
77
78 /**
79 * @since 1.2
80 */
81 public void writeText(Object object, UIComponent component, String string) throws IOException
82 {
83 writeText(object, string);
84 }
85 }