~testplan-team/testplan/source-collection

<A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">PREV CLASS</A>

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

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

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

<!--

if(window==top) {

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

}

//-->

</SCRIPT>

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

</NOSCRIPT>

</TD>

</TR>

<TR>

SUMMARY: NESTED | FIELD | <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.methods

Class StringRequestEntity</H2>

<PRE>

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

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

</PRE>

<DL>

<DT>All Implemented Interfaces: <DD><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">RequestEntity</A></DD>

</DL>

<HR>

100

<DL>

101

<DT><PRE>public class StringRequestEntity<DT>extends <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><DT>implements <A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">RequestEntity</A></DL>

102

</PRE>

103

104

105

A RequestEntity that contains a String.

106

107

108

109

<DL>

110

<DT>Since:</DT>

111

112

</DL>

113

<HR>

114

115

116

117

118

119

120

121

122

123

Constructor Summary</TH>

124

</TR>

125

126

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#StringRequestEntity(java.lang.String)">StringRequestEntity</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> content)</CODE>

127

128

129

Deprecated. use <A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#StringRequestEntity(java.lang.String, java.lang.String, java.lang.String)"><CODE>StringRequestEntity(String, String, String)</CODE></A> instead</TD>

130

</TR>

131

132

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#StringRequestEntity(java.lang.String, java.lang.String, java.lang.String)">StringRequestEntity</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> content,

133

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> contentType,

134

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> charset)</CODE>

135

136

137

Creates a new entity with the given content, content type, and charset.</TD>

138

</TR>

139

</TABLE>

140

141

142

143

144

145

146

147

Method Summary</TH>

148

</TR>

149

150

151

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></TD>

152

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#getCharset()">getCharset</A>()</CODE>

153

154

155

</TD>

156

</TR>

157

158

159

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></TD>

160

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#getContent()">getContent</A>()</CODE>

161

162

163

</TD>

164

</TR>

165

166

167

168

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#getContentLength()">getContentLength</A>()</CODE>

169

170

171

Gets the request entity's length.</TD>

172

</TR>

173

174

175

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></TD>

176

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#getContentType()">getContentType</A>()</CODE>

177

178

179

Gets the entity's content type.</TD>

180

</TR>

181

182

183

<CODE> boolean</CODE></TD>

184

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#isRepeatable()">isRepeatable</A>()</CODE>

185

186

187

Tests if <A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#writeRequest(java.io.OutputStream)"><CODE>RequestEntity.writeRequest(OutputStream)</CODE></A> can be called more than once.</TD>

188

</TR>

189

190

191

192

<TD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#writeRequest(java.io.OutputStream)">writeRequest</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> out)</CODE>

193

194

195

Writes the request entity to the given stream.</TD>

196

</TR>

197

</TABLE>

198

199

200

201

<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>

202

</TR>

203

204

<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>

205

</TR>

206

</TABLE>

207

208

209

210

211

212

213

214

215

216

Constructor Detail</TH>

217

</TR>

218

</TABLE>

219

220

221

StringRequestEntity</H3>

222

<PRE>

223

public StringRequestEntity(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> content)</PRE>

224

<DL>

225

<DD>Deprecated. use <A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#StringRequestEntity(java.lang.String, java.lang.String, java.lang.String)"><CODE>StringRequestEntity(String, String, String)</CODE></A> instead

226

227

<DD>Creates a new entity with the given content. This constructor

228

will use the default platform charset to convert the content string

229

and will provide no content type.

230

231

<DL>

232

<DT>Parameters:<DD><CODE>content</CODE> - The content to set.<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#StringRequestEntity(java.lang.String, java.lang.String, java.lang.String)"><CODE>StringRequestEntity(String, String, String)</CODE></A></DL>

233

</DL>

234

<HR>

235

236

237

StringRequestEntity</H3>

238

<PRE>

239

public StringRequestEntity(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> content,

240

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> contentType,

241

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> charset)

242

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

243

<DL>

244

<DD>Creates a new entity with the given content, content type, and charset.

245

246

<DL>

247

<DT>Parameters:<DD><CODE>content</CODE> - The content to set.<DD><CODE>contentType</CODE> - The type of the content, or <code>null</code>. The value retured

248

by <A HREF="../../../../../org/apache/commons/httpclient/methods/StringRequestEntity.html#getContentType()"><CODE>getContentType()</CODE></A>. If this content type contains a charset and the charset

249

parameter is null, the content's type charset will be used.<DD><CODE>charset</CODE> - The charset of the content, or <code>null</code>. Used to convert the

250

content to bytes. If the content type does not contain a charset and charset is not null,

251

then the charset will be appended to the content type.

252

<DT>Throws:

253

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

254

</DL>

255

256

257

258

259

260

261

262

Method Detail</TH>

263

</TR>

264

</TABLE>

265

266

267

getContentType</H3>

268

<PRE>

269

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> getContentType()</PRE>

270

<DL>

271

<DD>Description copied from interface: <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#getContentType()">RequestEntity</A></CODE></DD>

272

<DD>Gets the entity's content type. This content type will be used as the value for the

273

"Content-Type" header.

274

275

276

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#getContentType()">getContentType</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">RequestEntity</A></CODE></DL>

277

</DD>

278

279

280

<DT>Returns:<DD>the entity's content type<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/httpclient/HttpMethod.html#setRequestHeader(java.lang.String, java.lang.String)"><CODE>HttpMethod.setRequestHeader(String, String)</CODE></A></DL>

281

</DD>

282

</DL>

283

<HR>

284

285

286

isRepeatable</H3>

287

<PRE>

288

public boolean isRepeatable()</PRE>

289

<DL>

290

<DD>Description copied from interface: <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#isRepeatable()">RequestEntity</A></CODE></DD>

291

<DD>Tests if <A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#writeRequest(java.io.OutputStream)"><CODE>RequestEntity.writeRequest(OutputStream)</CODE></A> can be called more than once.

292

293

294

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#isRepeatable()">isRepeatable</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">RequestEntity</A></CODE></DL>

295

</DD>

296

297

298

<DT>Returns:<DD><code>true</code></DL>

299

</DD>

300

</DL>

301

<HR>

302

303

304

writeRequest</H3>

305

<PRE>

306

public void writeRequest(<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> out)

307

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>

308

<DL>

309

<DD>Description copied from interface: <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#writeRequest(java.io.OutputStream)">RequestEntity</A></CODE></DD>

310

<DD>Writes the request entity to the given stream.

311

312

313

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#writeRequest(java.io.OutputStream)">writeRequest</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">RequestEntity</A></CODE></DL>

314

</DD>

315

316

317

<DT>Throws:

318

<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>

319

</DD>

320

</DL>

321

<HR>

322

323

324

getContentLength</H3>

325

<PRE>

326

public long getContentLength()</PRE>

327

<DL>

328

<DD>Description copied from interface: <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#getContentLength()">RequestEntity</A></CODE></DD>

329

<DD>Gets the request entity's length. This method should return a non-negative value if the content

330

length is known or a negative value if it is not. In the latter case the

331

<A HREF="../../../../../org/apache/commons/httpclient/methods/EntityEnclosingMethod.html" title="class in org.apache.commons.httpclient.methods"><CODE>EntityEnclosingMethod</CODE></A> will use chunk encoding to

332

transmit the request entity.

333

334

335

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html#getContentLength()">getContentLength</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">RequestEntity</A></CODE></DL>

336

</DD>

337

338

339

<DT>Returns:<DD>The length of the content.</DL>

340

</DD>

341

</DL>

342

<HR>

343

344

345

getContent</H3>

346

<PRE>

347

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> getContent()</PRE>

348

<DL>

349

350

</DL>

351

</DD>

352

353

354

<DT>Returns:<DD>Returns the content.</DL>

355

</DD>

356

</DL>

357

<HR>

358

359

360

getCharset</H3>

361

<PRE>

362

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> getCharset()</PRE>

363

<DL>

364

365

</DL>

366

</DD>

367

368

369

<DT>Returns:<DD>Returns the charset used to convert the content to bytes. <code>null</code> if

370

no charset as been specified.</DL>

371

</DD>

372

</DL>

373

374

<HR>

375

376

377

378

379

380

381

<TR>

382

383

384

385

386

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

387

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

388

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

389

390

391

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

392

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

393

394

</TR>

395

</TABLE>

396

</TD>

397

398

399

</TD>

400

</TR>

401

402

<TR>

403

404

<A HREF="../../../../../org/apache/commons/httpclient/methods/RequestEntity.html" title="interface in org.apache.commons.httpclient.methods">PREV CLASS</A>

405

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

406

407

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

408

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

409

410

<!--

411

if(window==top) {

412

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

413

}

414

//-->

415

</SCRIPT>

416

417

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

418

</NOSCRIPT>

419

420

421

</TD>

422

</TR>

423

<TR>

424

425

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

426

427

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

428

</TR>

429

</TABLE>

430

431

432

433

<HR>

434

435

</BODY>

436

</HTML>

Older »