1 |
/* SQLOutput.java -- Write SQL values to a stream |
/* SQLOutput.java -- Write SQL values to a stream |
2 |
Copyright (C) 1999, 2000 Free Software Foundation, Inc. |
Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc. |
3 |
|
|
4 |
This file is part of GNU Classpath. |
This file is part of GNU Classpath. |
5 |
|
|
41 |
import java.io.InputStream; |
import java.io.InputStream; |
42 |
import java.io.Reader; |
import java.io.Reader; |
43 |
import java.math.BigDecimal; |
import java.math.BigDecimal; |
44 |
|
import java.net.URL; |
45 |
|
|
46 |
/** |
/** |
47 |
* This interface provides methods for writing Java types to a SQL stream. |
* This interface provides methods for writing Java types to a SQL stream. |
48 |
* It is used for implemented custom type mappings for user defined data |
* It is used for implemented custom type mappings for user defined data |
49 |
* types. |
* types. |
50 |
* |
* |
51 |
* @author Aaron M. Renn (arenn@urbanophile.com) |
* @author Aaron M. Renn (arenn@urbanophile.com) |
52 |
*/ |
*/ |
53 |
public interface SQLOutput |
public interface SQLOutput |
54 |
{ |
{ |
55 |
|
/** |
56 |
/*************************************************************************/ |
* This method writes the specified Java <code>String</code> |
57 |
|
* to the SQL stream. |
58 |
/** |
* |
59 |
* This method writes the specified Java <code>String</code> |
* @param value The value to write to the stream. |
60 |
* to the SQL stream. |
* @exception SQLException If an error occurs. |
61 |
* |
*/ |
62 |
* @param value The value to write to the stream. |
public void writeString(String x) throws SQLException; |
63 |
* |
|
64 |
* @exception SQLException If an error occurs. |
/** |
65 |
*/ |
* This method writes the specified Java <code>boolean</code> |
66 |
public abstract void |
* to the SQL stream. |
67 |
writeString(String value) throws SQLException; |
* |
68 |
|
* @param value The value to write to the stream. |
69 |
/*************************************************************************/ |
* @exception SQLException If an error occurs. |
70 |
|
*/ |
71 |
/** |
public void writeBoolean(boolean x) throws SQLException; |
72 |
* This method writes the specified Java <code>boolean</code> |
|
73 |
* to the SQL stream. |
/** |
74 |
* |
* This method writes the specified Java <code>byte</code> |
75 |
* @param value The value to write to the stream. |
* to the SQL stream. |
76 |
* |
* |
77 |
* @exception SQLException If an error occurs. |
* @param value The value to write to the stream. |
78 |
*/ |
* @exception SQLException If an error occurs. |
79 |
public abstract void |
*/ |
80 |
writeBoolean(boolean value) throws SQLException; |
public void writeByte(byte x) throws SQLException; |
81 |
|
|
82 |
/*************************************************************************/ |
/** |
83 |
|
* This method writes the specified Java <code>short</code> |
84 |
/** |
* to the SQL stream. |
85 |
* This method writes the specified Java <code>byte</code> |
* |
86 |
* to the SQL stream. |
* @param value The value to write to the stream. |
87 |
* |
* @exception SQLException If an error occurs. |
88 |
* @param value The value to write to the stream. |
*/ |
89 |
* |
public void writeShort(short x) throws SQLException; |
90 |
* @exception SQLException If an error occurs. |
|
91 |
*/ |
/** |
92 |
public abstract void |
* This method writes the specified Java <code>int</code> |
93 |
writeByte(byte value) throws SQLException; |
* to the SQL stream. |
94 |
|
* |
95 |
/*************************************************************************/ |
* @param value The value to write to the stream. |
96 |
|
* @exception SQLException If an error occurs. |
97 |
/** |
*/ |
98 |
* This method writes the specified Java <code>short</code> |
public void writeInt(int x) throws SQLException; |
99 |
* to the SQL stream. |
|
100 |
* |
/** |
101 |
* @param value The value to write to the stream. |
* This method writes the specified Java <code>long</code> |
102 |
* |
* to the SQL stream. |
103 |
* @exception SQLException If an error occurs. |
* |
104 |
*/ |
* @param value The value to write to the stream. |
105 |
public abstract void |
* @exception SQLException If an error occurs. |
106 |
writeShort(short value) throws SQLException; |
*/ |
107 |
|
public void writeLong(long x) throws SQLException; |
108 |
/*************************************************************************/ |
|
109 |
|
/** |
110 |
/** |
* This method writes the specified Java <code>float</code> |
111 |
* This method writes the specified Java <code>int</code> |
* to the SQL stream. |
112 |
* to the SQL stream. |
* |
113 |
* |
* @param value The value to write to the stream. |
114 |
* @param value The value to write to the stream. |
* @exception SQLException If an error occurs. |
115 |
* |
*/ |
116 |
* @exception SQLException If an error occurs. |
public void writeFloat(float x) throws SQLException; |
117 |
*/ |
|
118 |
public abstract void |
/** |
119 |
writeInt(int value) throws SQLException; |
* This method writes the specified Java <code>double</code> |
120 |
|
* to the SQL stream. |
121 |
/*************************************************************************/ |
* |
122 |
|
* @param value The value to write to the stream. |
123 |
/** |
* @exception SQLException If an error occurs. |
124 |
* This method writes the specified Java <code>long</code> |
*/ |
125 |
* to the SQL stream. |
public void writeDouble(double x) throws SQLException; |
126 |
* |
|
127 |
* @param value The value to write to the stream. |
/** |
128 |
* |
* This method writes the specified Java <code>BigDecimal</code> |
129 |
* @exception SQLException If an error occurs. |
* to the SQL stream. |
130 |
*/ |
* |
131 |
public abstract void |
* @param value The value to write to the stream. |
132 |
writeLong(long value) throws SQLException; |
* @exception SQLException If an error occurs. |
133 |
|
*/ |
134 |
/*************************************************************************/ |
public void writeBigDecimal(BigDecimal x) throws SQLException; |
135 |
|
|
136 |
/** |
/** |
137 |
* This method writes the specified Java <code>float</code> |
* This method writes the specified Java <code>byte</code> array |
138 |
* to the SQL stream. |
* to the SQL stream. |
139 |
* |
* |
140 |
* @param value The value to write to the stream. |
* @param value The value to write to the stream. |
141 |
* |
* @exception SQLException If an error occurs. |
142 |
* @exception SQLException If an error occurs. |
*/ |
143 |
*/ |
public void writeBytes(byte[] x) throws SQLException; |
144 |
public abstract void |
|
145 |
writeFloat(float value) throws SQLException; |
/** |
146 |
|
* This method writes the specified Java <code>java.sql.Date</code> |
147 |
/*************************************************************************/ |
* to the SQL stream. |
148 |
|
* |
149 |
/** |
* @param value The value to write to the stream. |
150 |
* This method writes the specified Java <code>double</code> |
* @exception SQLException If an error occurs. |
151 |
* to the SQL stream. |
*/ |
152 |
* |
public void writeDate(Date x) throws SQLException; |
153 |
* @param value The value to write to the stream. |
|
154 |
* |
/** |
155 |
* @exception SQLException If an error occurs. |
* This method writes the specified Java <code>java.sql.Time</code> |
156 |
*/ |
* to the SQL stream. |
157 |
public abstract void |
* |
158 |
writeDouble(double value) throws SQLException; |
* @param value The value to write to the stream. |
159 |
|
* @exception SQLException If an error occurs. |
160 |
/*************************************************************************/ |
*/ |
161 |
|
public void writeTime(Time x) throws SQLException; |
162 |
/** |
|
163 |
* This method writes the specified Java <code>BigDecimal</code> |
/** |
164 |
* to the SQL stream. |
* This method writes the specified Java <code>java.sql.Timestamp</code> |
165 |
* |
* to the SQL stream. |
166 |
* @param value The value to write to the stream. |
* |
167 |
* |
* @param value The value to write to the stream. |
168 |
* @exception SQLException If an error occurs. |
* @exception SQLException If an error occurs. |
169 |
*/ |
*/ |
170 |
public abstract void |
public void writeTimestamp(Timestamp x) throws SQLException; |
171 |
writeBigDecimal(BigDecimal value) throws SQLException; |
|
172 |
|
/** |
173 |
/*************************************************************************/ |
* This method writes the specified Java character stream |
174 |
|
* to the SQL stream. |
175 |
/** |
* |
176 |
* This method writes the specified Java <code>byte</code> array |
* @param value The value to write to the stream. |
177 |
* to the SQL stream. |
* @exception SQLException If an error occurs. |
178 |
* |
*/ |
179 |
* @param value The value to write to the stream. |
public void writeCharacterStream(Reader x) throws SQLException; |
180 |
* |
|
181 |
* @exception SQLException If an error occurs. |
/** |
182 |
*/ |
* This method writes the specified ASCII text stream |
183 |
public abstract void |
* to the SQL stream. |
184 |
writeBytes(byte[] value) throws SQLException; |
* |
185 |
|
* @param value The value to write to the stream. |
186 |
/*************************************************************************/ |
* @exception SQLException If an error occurs. |
187 |
|
*/ |
188 |
/** |
public void writeAsciiStream(InputStream x) throws SQLException; |
189 |
* This method writes the specified Java <code>java.sql.Date</code> |
|
190 |
* to the SQL stream. |
/** |
191 |
* |
* This method writes the specified uninterpreted binary byte stream |
192 |
* @param value The value to write to the stream. |
* to the SQL stream. |
193 |
* |
* |
194 |
* @exception SQLException If an error occurs. |
* @param value The value to write to the stream. |
195 |
*/ |
* @exception SQLException If an error occurs. |
196 |
public abstract void |
*/ |
197 |
writeDate(java.sql.Date value) throws SQLException; |
public void writeBinaryStream(InputStream x) throws SQLException; |
198 |
|
|
199 |
/*************************************************************************/ |
/** |
200 |
|
* This method writes the specified Java <code>SQLData</code> object |
201 |
/** |
* to the SQL stream. |
202 |
* This method writes the specified Java <code>java.sql.Time</code> |
* |
203 |
* to the SQL stream. |
* @param value The value to write to the stream. |
204 |
* |
* @exception SQLException If an error occurs. |
205 |
* @param value The value to write to the stream. |
*/ |
206 |
* |
public void writeObject(SQLData x) throws SQLException; |
207 |
* @exception SQLException If an error occurs. |
|
208 |
*/ |
/** |
209 |
public abstract void |
* This method writes the specified Java SQL <code>Ref</code> object |
210 |
writeTime(java.sql.Time value) throws SQLException; |
* to the SQL stream. |
211 |
|
* |
212 |
/*************************************************************************/ |
* @param value The value to write to the stream. |
213 |
|
* @exception SQLException If an error occurs. |
214 |
/** |
*/ |
215 |
* This method writes the specified Java <code>java.sql.Timestamp</code> |
public void writeRef(Ref x) throws SQLException; |
216 |
* to the SQL stream. |
|
217 |
* |
/** |
218 |
* @param value The value to write to the stream. |
* This method writes the specified Java SQL <code>Blob</code> object |
219 |
* |
* to the SQL stream. |
220 |
* @exception SQLException If an error occurs. |
* |
221 |
*/ |
* @param value The value to write to the stream. |
222 |
public abstract void |
* @exception SQLException If an error occurs. |
223 |
writeTimestamp(java.sql.Timestamp value) throws SQLException; |
*/ |
224 |
|
public void writeBlob(Blob x) throws SQLException; |
225 |
/*************************************************************************/ |
|
226 |
|
/** |
227 |
/** |
* This method writes the specified Java SQL <code>Clob</code> object |
228 |
* This method writes the specified Java character stream |
* to the SQL stream. |
229 |
* to the SQL stream. |
* |
230 |
* |
* @param value The value to write to the stream. |
231 |
* @param value The value to write to the stream. |
* @exception SQLException If an error occurs. |
232 |
* |
*/ |
233 |
* @exception SQLException If an error occurs. |
public void writeClob(Clob x) throws SQLException; |
234 |
*/ |
|
235 |
public abstract void |
/** |
236 |
writeCharacterStream(Reader value) throws SQLException; |
* This method writes the specified Java SQL <code>Struct</code> object |
237 |
|
* to the SQL stream. |
238 |
/*************************************************************************/ |
* |
239 |
|
* @param value The value to write to the stream. |
240 |
/** |
* @exception SQLException If an error occurs. |
241 |
* This method writes the specified uninterpreted binary byte stream |
*/ |
242 |
* to the SQL stream. |
public void writeStruct(Struct x) throws SQLException; |
243 |
* |
|
244 |
* @param value The value to write to the stream. |
/** |
245 |
* |
* This method writes the specified Java SQL <code>Array</code> object |
246 |
* @exception SQLException If an error occurs. |
* to the SQL stream. |
247 |
*/ |
* |
248 |
public abstract void |
* @param value The value to write to the stream. |
249 |
writeBinaryStream(InputStream value) throws SQLException; |
* @exception SQLException If an error occurs. |
250 |
|
*/ |
251 |
/*************************************************************************/ |
public void writeArray(Array x) throws SQLException; |
252 |
|
|
253 |
/** |
/** |
254 |
* This method writes the specified ASCII text stream |
* @since 1.4 |
255 |
* to the SQL stream. |
*/ |
256 |
* |
public void writeURL(URL x) throws SQLException; |
257 |
* @param value The value to write to the stream. |
} |
|
* |
|
|
* @exception SQLException If an error occurs. |
|
|
*/ |
|
|
public abstract void |
|
|
writeAsciiStream(InputStream value) throws SQLException; |
|
|
|
|
|
/*************************************************************************/ |
|
|
|
|
|
/** |
|
|
* This method writes the specified Java <code>SQLData</code> object |
|
|
* to the SQL stream. |
|
|
* |
|
|
* @param value The value to write to the stream. |
|
|
* |
|
|
* @exception SQLException If an error occurs. |
|
|
*/ |
|
|
public abstract void |
|
|
writeObject(SQLData value) throws SQLException; |
|
|
|
|
|
/*************************************************************************/ |
|
|
|
|
|
/** |
|
|
* This method writes the specified Java SQL <code>Ref</code> object |
|
|
* to the SQL stream. |
|
|
* |
|
|
* @param value The value to write to the stream. |
|
|
* |
|
|
* @exception SQLException If an error occurs. |
|
|
*/ |
|
|
public abstract void |
|
|
writeRef(Ref value) throws SQLException; |
|
|
|
|
|
/*************************************************************************/ |
|
|
|
|
|
/** |
|
|
* This method writes the specified Java SQL <code>Blob</code> object |
|
|
* to the SQL stream. |
|
|
* |
|
|
* @param value The value to write to the stream. |
|
|
* |
|
|
* @exception SQLException If an error occurs. |
|
|
*/ |
|
|
public abstract void |
|
|
writeBlob(Blob value) throws SQLException; |
|
|
|
|
|
/*************************************************************************/ |
|
|
|
|
|
/** |
|
|
* This method writes the specified Java SQL <code>Clob</code> object |
|
|
* to the SQL stream. |
|
|
* |
|
|
* @param value The value to write to the stream. |
|
|
* |
|
|
* @exception SQLException If an error occurs. |
|
|
*/ |
|
|
public abstract void |
|
|
writeClob(Clob value) throws SQLException; |
|
|
|
|
|
/*************************************************************************/ |
|
|
|
|
|
/** |
|
|
* This method writes the specified Java SQL <code>Struct</code> object |
|
|
* to the SQL stream. |
|
|
* |
|
|
* @param value The value to write to the stream. |
|
|
* |
|
|
* @exception SQLException If an error occurs. |
|
|
*/ |
|
|
public abstract void |
|
|
writeStruct(Struct value) throws SQLException; |
|
|
|
|
|
/*************************************************************************/ |
|
|
|
|
|
/** |
|
|
* This method writes the specified Java SQL <code>Array</code> object |
|
|
* to the SQL stream. |
|
|
* |
|
|
* @param value The value to write to the stream. |
|
|
* |
|
|
* @exception SQLException If an error occurs. |
|
|
*/ |
|
|
public abstract void |
|
|
writeArray(Array value) throws SQLException; |
|
|
|
|
|
} // interface SQLOutput |
|
|
|
|