~testplan-team/testplan/source-collection

<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">java.io.OutputStream</A>

<IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.apache.commons.httpclient.ChunkedOutputStream

</PRE>

<DL>

<DT>All Implemented Interfaces: <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Closeable.html" title="class or interface in java.io">Closeable</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Flushable.html" title="class or interface in java.io">Flushable</A></DD>

</DL>

100

<HR>

101

<DL>

102

<DT><PRE>public class ChunkedOutputStream<DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></DL>

103

</PRE>

104

105

106

Implements HTTP chunking support. Writes are buffered to an internal buffer (2048 default size).

107

Chunks are guaranteed to be at least as large as the buffer size (except for the last chunk).

108

109

110

111

<DL>

112

<DT>Author:</DT>

113

<DD>Mohammad Rezaei, Goldman, Sachs & Co.</DD>

114

</DL>

115

<HR>

116

117

118

119

120

121

122

123

124

125

Constructor Summary</TH>

126

</TR>

127

128

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html#ChunkedOutputStream(java.io.OutputStream)">ChunkedOutputStream</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> stream)</CODE>

129

130

131

Wraps a stream and chunks the output.</TD>

132

</TR>

133

134

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html#ChunkedOutputStream(java.io.OutputStream, int)">ChunkedOutputStream</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> stream,

135

int bufferSize)</CODE>

136

137

138

Wraps a stream and chunks the output.</TD>

139

</TR>

140

</TABLE>

141

142

143

144

145

146

147

148

Method Summary</TH>

149

</TR>

150

151

152

153

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

154

155

156

Finishes writing to the underlying stream, but does NOT close the underlying stream.</TD>

157

</TR>

158

159

160

161

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

162

163

164

Must be called to ensure the internal cache is flushed and the closing chunk is written.</TD>

165

</TR>

166

167

168

169

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

170

171

172

Flushes the underlying stream, but leaves the internal buffer alone.</TD>

173

</TR>

174

175

176

<CODE>protected  void</CODE></TD>

177

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

178

179

180

Writes the cache out onto the underlying stream</TD>

181

</TR>

182

183

184

<CODE>protected  void</CODE></TD>

185

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html#flushCacheWithAppend(byte[], int, int)">flushCacheWithAppend</A>(byte[] bufferToAppend,

186

int off,

187

int len)</CODE>

188

189

190

          Writes the cache and bufferToAppend to the underlying stream

191

as one large chunk</TD>

192

</TR>

193

194

195

196

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html#write(byte[])">write</A>(byte[] b)</CODE>

197

198

199

Writes the array.</TD>

200

</TR>

201

202

203

204

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html#write(byte[], int, int)">write</A>(byte[] src,

205

int off,

206

int len)</CODE>

207

208

209

</TD>

210

</TR>

211

212

213

214

<TD><CODE><A HREF="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html#write(int)">write</A>(int b)</CODE>

215

216

217

Write the specified byte to our output stream.</TD>

218

</TR>

219

220

221

<CODE>protected  void</CODE></TD>

222

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

223

224

225

</TD>

226

</TR>

227

</TABLE>

228

229

230

231

<TH ALIGN="left">Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></TH>

232

</TR>

233

234

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

235

</TR>

236

</TABLE>

237

238

239

240

241

242

243

244

245

246

Constructor Detail</TH>

247

</TR>

248

</TABLE>

249

250

251

ChunkedOutputStream</H3>

252

<PRE>

253

public ChunkedOutputStream(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> stream,

254

int bufferSize)

255

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

256

<DL>

257

<DD>Wraps a stream and chunks the output.

258

259

<DL>

260

<DT>Parameters:<DD><CODE>stream</CODE> - to wrap<DD><CODE>bufferSize</CODE> - minimum chunk size (excluding last chunk)

261

<DT>Throws:

262

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE><DT>Since:</DT>

263

264

</DL>

265

</DL>

266

<HR>

267

268

269

ChunkedOutputStream</H3>

270

<PRE>

271

public ChunkedOutputStream(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> stream)

272

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

273

<DL>

274

<DD>Wraps a stream and chunks the output. The default buffer size of 2048 was chosen because

275

the chunk overhead is less than 0.5%

276

277

<DL>

278

<DT>Parameters:<DD><CODE>stream</CODE> -

279

<DT>Throws:

280

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>

281

</DL>

282

283

284

285

286

287

288

289

Method Detail</TH>

290

</TR>

291

</TABLE>

292

293

294

flushCache</H3>

295

<PRE>

296

protected void flushCache()

297

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

298

<DL>

299

<DD>Writes the cache out onto the underlying stream

300

301

302

303

<DT>Throws:

304

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE><DT>Since:</DT>

305

306

</DL>

307

</DD>

308

</DL>

309

<HR>

310

311

312

flushCacheWithAppend</H3>

313

<PRE>

314

protected void flushCacheWithAppend(byte[] bufferToAppend,

315

int off,

316

int len)

317

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

318

<DL>

319

<DD>Writes the cache and bufferToAppend to the underlying stream

320

as one large chunk

321

322

323

<DT>Parameters:<DD><CODE>bufferToAppend</CODE> - <DD><CODE>off</CODE> - <DD><CODE>len</CODE> -

324

<DT>Throws:

325

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE><DT>Since:</DT>

326

327

</DL>

328

</DD>

329

</DL>

330

<HR>

331

332

333

writeClosingChunk</H3>

334

<PRE>

335

protected void writeClosingChunk()

336

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

337

<DL>

338

339

340

<DT>Throws:

341

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>

342

</DD>

343

</DL>

344

<HR>

345

346

347

finish</H3>

348

<PRE>

349

public void finish()

350

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

351

<DL>

352

<DD>Must be called to ensure the internal cache is flushed and the closing chunk is written.

353

354

355

356

<DT>Throws:

357

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE><DT>Since:</DT>

358

359

</DL>

360

</DD>

361

</DL>

362

<HR>

363

364

365

write</H3>

366

<PRE>

367

public void write(int b)

368

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

369

<DL>

370

<DD>Write the specified byte to our output stream.

371

372

Note: Avoid this method as it will cause an inefficient single byte chunk.

373

Use write (byte[], int, int) instead.

374

375

376

<DT>Specified by:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html#write(int)" title="class or interface in java.io">write</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></DL>

377

</DD>

378

379

<DT>Parameters:<DD><CODE>b</CODE> - The byte to be written

380

<DT>Throws:

381

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an input/output error occurs</DL>

382

</DD>

383

</DL>

384

<HR>

385

386

387

write</H3>

388

<PRE>

389

public void write(byte[] b)

390

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

391

<DL>

392

<DD>Writes the array. If the array does not fit within the buffer, it is

393

not split, but rather written out as one large chunk.

394

395

396

<DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html#write(byte[])" title="class or interface in java.io">write</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></DL>

397

</DD>

398

399

<DT>Parameters:<DD><CODE>b</CODE> -

400

<DT>Throws:

401

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE><DT>Since:</DT>

402

403

</DL>

404

</DD>

405

</DL>

406

<HR>

407

408

409

write</H3>

410

<PRE>

411

public void write(byte[] src,

412

int off,

413

int len)

414

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

415

<DL>

416

417

<DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html#write(byte[], int, int)" title="class or interface in java.io">write</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></DL>

418

</DD>

419

420

421

<DT>Throws:

422

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>

423

</DD>

424

</DL>

425

<HR>

426

427

428

flush</H3>

429

<PRE>

430

public void flush()

431

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

432

<DL>

433

<DD>Flushes the underlying stream, but leaves the internal buffer alone.

434

435

436

<DT>Specified by:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Flushable.html#flush()" title="class or interface in java.io">flush</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Flushable.html" title="class or interface in java.io">Flushable</A></CODE><DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html#flush()" title="class or interface in java.io">flush</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></DL>

437

</DD>

438

439

440

<DT>Throws:

441

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>

442

</DD>

443

</DL>

444

<HR>

445

446

447

close</H3>

448

<PRE>

449

public void close()

450

throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>

451

<DL>

452

<DD>Finishes writing to the underlying stream, but does NOT close the underlying stream.

453

454

455

<DT>Specified by:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Closeable.html#close()" title="class or interface in java.io">close</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Closeable.html" title="class or interface in java.io">Closeable</A></CODE><DT>Overrides:<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html#close()" title="class or interface in java.io">close</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></DL>

456

</DD>

457

458

459

<DT>Throws:

460

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>

461

</DD>

462

</DL>

463

464

<HR>

465

466

467

468

469

470

471

<TR>

472

473

474

475

476

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

477

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

478

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

479

480

481

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

482

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

483

484

</TR>

485

</TABLE>

486

</TD>

487

488

489

</TD>

490

</TR>

491

492

<TR>

493

494

<A HREF="../../../../org/apache/commons/httpclient/ChunkedInputStream.html" title="class in org.apache.commons.httpclient">PREV CLASS</A>

495

<A HREF="../../../../org/apache/commons/httpclient/CircularRedirectException.html" title="class in org.apache.commons.httpclient">NEXT CLASS</A></TD>

496

497

<A HREF="../../../../index.html?org/apache/commons/httpclient/ChunkedOutputStream.html" target="_top">FRAMES</A>

498

<A HREF="ChunkedOutputStream.html" target="_top">NO FRAMES</A>

499

500

<!--

501

if(window==top) {

502

document.writeln('<A HREF="../../../../allclasses-noframe.html">All Classes</A>');

503

}

504

//-->

505

</SCRIPT>

506

507

<A HREF="../../../../allclasses-noframe.html">All Classes</A>

508

</NOSCRIPT>

509

510

511

</TD>

512

</TR>

513

<TR>

514

515

SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></TD>

516

517

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

518

</TR>

519

</TABLE>

520

521

522

523

<HR>

524

525

</BODY>

526

</HTML>

Older »