~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

SUMMARY:  INNER | <A HREF="#fields_inherited_from_class_java.io.FilterInputStream">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></TD>

DETAIL:  FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></TD>

</TR>

</TABLE>

<HR>

<H2>

org.apache.commons.httpclient

Class AutoCloseInputStream</H2>

<PRE>

<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">java.lang.Object</A>

+--<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/InputStream.html">java.io.InputStream</A>

+--<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">java.io.FilterInputStream</A>

+--org.apache.commons.httpclient.AutoCloseInputStream

</PRE>

<HR>

<DL>

<DT> class AutoCloseInputStream<DT>extends <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">FilterInputStream</A></DL>

Closes an underlying stream as soon as the end of the stream is reached, and

notifies a client when it has done so.

<DL>

<DT>Since: <DD>2.0</DD>

<DT>Author: <DD>Ortwin Gl?ck, Eric Johnson, <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a></DD>

</DL>

<HR>

<TD>Fields inherited from class java.io.<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">FilterInputStream</A></TD>

</TR>

</TR>

</TABLE>

100

101

102

103

104

105

106

Constructor Summary</TD>

107

</TR>

108

109

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/AutoCloseInputStream.html#AutoCloseInputStream(java.io.InputStream, org.apache.commons.httpclient.ResponseConsumedWatcher)">AutoCloseInputStream</A>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/InputStream.html">InputStream</A> in,

110

<A HREF="../../../../org/apache/commons/httpclient/ResponseConsumedWatcher.html">ResponseConsumedWatcher</A> watcher)</CODE>

111

112

113

Create a new auto closing stream for the provided connection</TD>

114

</TR>

115

</TABLE>

116

117

118

119

120

121

122

123

Method Summary</TD>

124

</TR>

125

126

127

128

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/AutoCloseInputStream.html#close()">close</A>()</CODE>

129

130

131

          Close the stream, and also close the underlying stream if it is not

132

already closed.</TD>

133

</TR>

134

135

136

137

138

139

140

Reads the next byte of data from the input stream.</TD>

141

</TR>

142

143

144

145

146

147

148

          Reads some number of bytes from the input stream and stores them into the

149

buffer array b.</TD>

150

</TR>

151

152

153

154

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/AutoCloseInputStream.html#read(byte[], int, int)">read</A>(byte[] b,

155

int off,

156

int len)</CODE>

157

158

159

Reads up to <code>len</code> bytes of data from the stream.</TD>

160

</TR>

161

</TABLE>

162

163

164

165

<TD>Methods inherited from class java.io.<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">FilterInputStream</A></TD>

166

</TR>

167

168

<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#available()">available</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#mark(int)">mark</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#markSupported()">markSupported</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#reset()">reset</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#skip(long)">skip</A></CODE></TD>

169

</TR>

170

</TABLE>

171

172

173

174

<TD>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></TD>

175

</TR>

176

177

<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#<clinit>()"><clinit></A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>

178

</TR>

179

</TABLE>

180

181

182

183

184

185

186

187

188

189

190

191

192

Constructor Detail</TD>

193

</TR>

194

</TABLE>

195

196

197

AutoCloseInputStream</H3>

198

<PRE>

199

public AutoCloseInputStream(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/InputStream.html">InputStream</A> in,

200

<A HREF="../../../../org/apache/commons/httpclient/ResponseConsumedWatcher.html">ResponseConsumedWatcher</A> watcher)</PRE>

201

<DL>

202

<DD>Create a new auto closing stream for the provided connection<DD><DL>

203

<DT>Parameters:<DD><CODE>in</CODE> - the input stream to read from<DD><CODE>watcher</CODE> - To be notified when the contents of the stream have been

204

consumed.</DL>

205

</DD>

206

</DL>

207

208

209

210

211

212

213

214

Method Detail</TD>

215

</TR>

216

</TABLE>

217

218

219

read</H3>

220

<PRE>

221

public int read()

222

throws <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></PRE>

223

<DL>

224

<DD>Reads the next byte of data from the input stream.<DD><DL>

225

<DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#read()">read</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">FilterInputStream</A></CODE></DL>

226

</DD>

227

228

<DT>Returns:<DD>the character read, or -1 for EOF<DT>Throws:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></CODE> - when there is an error reading</DL>

229

</DD>

230

</DL>

231

<HR>

232

233

234

read</H3>

235

<PRE>

236

public int read(byte[] b,

237

int off,

238

int len)

239

throws <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></PRE>

240

<DL>

241

<DD>Reads up to <code>len</code> bytes of data from the stream.<DD><DL>

242

<DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#read(byte[], int, int)">read</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">FilterInputStream</A></CODE></DL>

243

</DD>

244

245

<DT>Parameters:<DD><CODE>b</CODE> - a <code>byte</code> array to read data into<DD><CODE>off</CODE> - an offset within the array to store data<DD><CODE>len</CODE> - the maximum number of bytes to read<DT>Returns:<DD>the number of bytes read or -1 for EOF<DT>Throws:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></CODE> - if there are errors reading</DL>

246

</DD>

247

</DL>

248

<HR>

249

250

251

read</H3>

252

<PRE>

253

public int read(byte[] b)

254

throws <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></PRE>

255

<DL>

256

<DD>Reads some number of bytes from the input stream and stores them into the

257

buffer array b.<DD><DL>

258

<DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#read(byte[])">read</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">FilterInputStream</A></CODE></DL>

259

</DD>

260

261

<DT>Parameters:<DD><CODE>b</CODE> - a <code>byte</code> array to read data into<DT>Returns:<DD>the number of bytes read or -1 for EOF<DT>Throws:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></CODE> - if there are errors reading</DL>

262

</DD>

263

</DL>

264

<HR>

265

266

267

close</H3>

268

<PRE>

269

public void close()

270

throws <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></PRE>

271

<DL>

272

<DD>Close the stream, and also close the underlying stream if it is not

273

already closed.<DD><DL>

274

<DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html#close()">close</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterInputStream.html">FilterInputStream</A></CODE></DL>

275

</DD>

276

277

<DT>Throws:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/IOException.html">IOException</A></CODE> - If an IO problem occurs.</DL>

278

</DD>

279

</DL>

280

281

<HR>

282

283

284

285

286

<TR>

287

288

289

290

291

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A> </TD>

292

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD>

293

<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD>

294

295

296

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A> </TD>

297

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A> </TD>

298

299

</TR>

300

</TABLE>

301

</TD>

302

303

304

</TD>

305

</TR>

306

307

<TR>

308

309

<A HREF="../../../../org/apache/commons/httpclient/Authenticator.html">PREV CLASS</A>

310

<A HREF="../../../../org/apache/commons/httpclient/ChunkedInputStream.html">NEXT CLASS</A></TD>

311

312

<A HREF="../../../../index.html" TARGET="_top">FRAMES</A>

313

<A HREF="AutoCloseInputStream.html" TARGET="_top">NO FRAMES</A></TD>

314

</TR>

315

<TR>

316

317

SUMMARY:  INNER | <A HREF="#fields_inherited_from_class_java.io.FilterInputStream">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></TD>

318

319

DETAIL:  FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></TD>

320

</TR>

321

</TABLE>

322

323

324

<HR>

325

326

</BODY>

327

</HTML>

Older »