~s-friedemann/tomdroid/sshfs

<DT>All Implemented Interfaces: <DD><A HREF="../../../../../org/apache/commons/codec/BinaryDecoder.html" title="interface in org.apache.commons.codec">BinaryDecoder</A>, <A HREF="../../../../../org/apache/commons/codec/BinaryEncoder.html" title="interface in org.apache.commons.codec">BinaryEncoder</A>, <A HREF="../../../../../org/apache/commons/codec/Decoder.html" title="interface in org.apache.commons.codec">Decoder</A>, <A HREF="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A>, <A HREF="../../../../../org/apache/commons/codec/StringDecoder.html" title="interface in org.apache.commons.codec">StringDecoder</A>, <A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></DD>

101

</DL>

102

<HR>

103

<DL>

104

<DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.53">URLCodec</A><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/commons/codec/BinaryEncoder.html" title="interface in org.apache.commons.codec">BinaryEncoder</A>, <A HREF="../../../../../org/apache/commons/codec/BinaryDecoder.html" title="interface in org.apache.commons.codec">BinaryDecoder</A>, <A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A>, <A HREF="../../../../../org/apache/commons/codec/StringDecoder.html" title="interface in org.apache.commons.codec">StringDecoder</A></DL>

105

</PRE>

106

107

108

Implements the 'www-form-urlencoded' encoding scheme,

109

also misleadingly known as URL encoding.

110

111

For more detailed information please refer to

112

113

Chapter 17.13.4 'Form content types'</a> of the

114

<a href="http://www.w3.org/TR/html4/">HTML 4.01 Specification<a>

115

116

117

This codec is meant to be a replacement for standard Java classes

118

<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URLEncoder.html?is-external=true" title="class or interface in java.net"><CODE>URLEncoder</CODE></A> and <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URLDecoder.html?is-external=true" title="class or interface in java.net"><CODE>URLDecoder</CODE></A>

119

on older Java platforms, as these classes in Java versions below

120

1.4 rely on the platform's default charset encoding.

121

122

123

124

125

<DL>

126

<DT>Since:</DT>

127

128

<DT>Version:</DT>

129

<DD>$Id: URLCodec.java 798416 2009-07-28 06:35:58Z ggregory $</DD>

130

<DT>Author:</DT>

131

<DD>Apache Software Foundation</DD>

132

</DL>

133

<HR>

134

135

136

137

138

139

140

141

142

Field Summary</TH>

143

</TR>

144

145

146

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

147

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#charset">charset</A></CODE>

148

149

150

The default charset used for string decoding and encoding.</TD>

151

</TR>

152

153

154

<CODE>protected static byte</CODE></TD>

155

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#ESCAPE_CHAR">ESCAPE_CHAR</A></CODE>

156

157

158

Consider this field final.</TD>

159

</TR>

160

161

162

<CODE>protected static <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</A></CODE></TD>

163

164

165

166

BitSet of www-form-url safe characters.</TD>

167

</TR>

168

</TABLE>

169

170

171

172

173

174

175

176

Constructor Summary</TH>

177

</TR>

178

179

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#URLCodec()">URLCodec</A>()</CODE>

180

181

182

Default constructor.</TD>

183

</TR>

184

185

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#URLCodec(java.lang.String)">URLCodec</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> charset)</CODE>

186

187

188

Constructor which allows for the selection of a default charset</TD>

189

</TR>

190

</TABLE>

191

192

193

194

195

196

197

198

Method Summary</TH>

199

</TR>

200

201

202

203

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#decode(byte[])">decode</A>(byte[] bytes)</CODE>

204

205

206

          Decodes an array of URL safe 7-bit characters into an array of

207

original bytes.</TD>

208

</TR>

209

210

211

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></TD>

212

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#decode(java.lang.Object)">decode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> pObject)</CODE>

213

214

215

Decodes a URL safe object into its original form.</TD>

216

</TR>

217

218

219

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

220

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#decode(java.lang.String)">decode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString)</CODE>

221

222

223

          Decodes a URL safe string into its original form using the default

224

string charset.</TD>

225

</TR>

226

227

228

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

229

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#decode(java.lang.String, java.lang.String)">decode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString,

230

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

231

232

233

          Decodes a URL safe string into its original form using the

234

specified encoding.</TD>

235

</TR>

236

237

238

<CODE>static byte[]</CODE></TD>

239

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#decodeUrl(byte[])">decodeUrl</A>(byte[] bytes)</CODE>

240

241

242

          Decodes an array of URL safe 7-bit characters into an array of

243

original bytes.</TD>

244

</TR>

245

246

247

248

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#encode(byte[])">encode</A>(byte[] bytes)</CODE>

249

250

251

          Encodes an array of bytes into an array of URL safe 7-bit

252

characters.</TD>

253

</TR>

254

255

256

<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></TD>

257

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#encode(java.lang.Object)">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> pObject)</CODE>

258

259

260

Encodes an object into its URL safe form.</TD>

261

</TR>

262

263

264

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

265

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#encode(java.lang.String)">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString)</CODE>

266

267

268

          Encodes a string into its URL safe form using the default string

269

charset.</TD>

270

</TR>

271

272

273

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

274

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#encode(java.lang.String, java.lang.String)">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString,

275

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

276

277

278

Encodes a string into its URL safe form using the specified string charset.</TD>

279

</TR>

280

281

282

<CODE>static byte[]</CODE></TD>

283

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#encodeUrl(java.util.BitSet, byte[])">encodeUrl</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</A> urlsafe,

284

byte[] bytes)</CODE>

285

286

287

Encodes an array of bytes into an array of URL safe 7-bit characters.</TD>

288

</TR>

289

290

291

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

292

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#getDefaultCharset()">getDefaultCharset</A>()</CODE>

293

294

295

The default charset used for string decoding and encoding.</TD>

296

</TR>

297

298

299

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

300

<TD><CODE><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#getEncoding()">getEncoding</A>()</CODE>

301

302

303

Deprecated. use #getDefaultCharset()</TD>

304

</TR>

305

</TABLE>

306

307

308

309

<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?is-external=true" title="class or interface in java.lang">Object</A></TH>

310

</TR>

311

312

<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>

313

</TR>

314

</TABLE>

315

316

317

318

319

320

321

322

323

324

Field Detail</TH>

325

</TR>

326

</TABLE>

327

328

329

charset</H3>

330

<PRE>

331

protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.64">charset</A></PRE>

332

<DL>

333

<DD>The default charset used for string decoding and encoding. Consider this field final. The next major release may

334

break compatibility and make this field be final.

335

336

<DL>

337

</DL>

338

</DL>

339

<HR>

340

341

342

ESCAPE_CHAR</H3>

343

<PRE>

344

protected static byte <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.69">ESCAPE_CHAR</A></PRE>

345

<DL>

346

<DD>Consider this field final. The next major release may break compatibility and make this field be final.

347

348

<DL>

349

</DL>

350

</DL>

351

<HR>

352

353

354

WWW_FORM_URL</H3>

355

<PRE>

356

protected static final <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.73">WWW_FORM_URL</A></PRE>

357

<DL>

358

<DD>BitSet of www-form-url safe characters.

359

360

<DL>

361

</DL>

362

</DL>

363

364

365

366

367

368

369

370

Constructor Detail</TH>

371

</TR>

372

</TABLE>

373

374

375

URLCodec</H3>

376

<PRE>

377

public <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.101">URLCodec</A>()</PRE>

378

<DL>

379

<DD>Default constructor.

380

381

</DL>

382

<HR>

383

384

385

URLCodec</H3>

386

<PRE>

387

public <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.110">URLCodec</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> charset)</PRE>

388

<DL>

389

<DD>Constructor which allows for the selection of a default charset

390

391

<DL>

392

<DT>Parameters:<DD><CODE>charset</CODE> - the default string charset to use.</DL>

393

</DL>

394

395

396

397

398

399

400

401

Method Detail</TH>

402

</TR>

403

</TABLE>

404

405

406

encodeUrl</H3>

407

<PRE>

408

public static final byte[] <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.124">encodeUrl</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</A> urlsafe,

409

byte[] bytes)</PRE>

410

<DL>

411

<DD>Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters are escaped.

412

413

414

</DL>

415

</DD>

416

417

<DT>Parameters:<DD><CODE>urlsafe</CODE> - bitset of characters deemed URL safe<DD><CODE>bytes</CODE> - array of bytes to convert to URL safe characters

418

<DT>Returns:<DD>array of bytes containing URL safe characters</DL>

419

</DD>

420

</DL>

421

<HR>

422

423

424

decodeUrl</H3>

425

<PRE>

426

public static final byte[] <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.163">decodeUrl</A>(byte[] bytes)

427

throws <A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></PRE>

428

<DL>

429

<DD>Decodes an array of URL safe 7-bit characters into an array of

430

original bytes. Escaped characters are converted back to their

431

original representation.

432

433

434

</DL>

435

</DD>

436

437

<DT>Parameters:<DD><CODE>bytes</CODE> - array of URL safe characters

438

<DT>Returns:<DD>array of original bytes

439

<DT>Throws:

440

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></CODE> - Thrown if URL decoding is unsuccessful</DL>

441

</DD>

442

</DL>

443

<HR>

444

445

446

encode</H3>

447

<PRE>

448

public byte[] <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.194">encode</A>(byte[] bytes)</PRE>

449

<DL>

450

<DD>Encodes an array of bytes into an array of URL safe 7-bit

451

characters. Unsafe characters are escaped.

452

453

454

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/BinaryEncoder.html#encode(byte[])">encode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/BinaryEncoder.html" title="interface in org.apache.commons.codec">BinaryEncoder</A></CODE></DL>

455

</DD>

456

457

<DT>Parameters:<DD><CODE>bytes</CODE> - array of bytes to convert to URL safe characters

458

<DT>Returns:<DD>array of bytes containing URL safe characters</DL>

459

</DD>

460

</DL>

461

<HR>

462

463

464

decode</H3>

465

<PRE>

466

public byte[] <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.208">decode</A>(byte[] bytes)

467

throws <A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></PRE>

468

<DL>

469

<DD>Decodes an array of URL safe 7-bit characters into an array of

470

original bytes. Escaped characters are converted back to their

471

original representation.

472

473

474

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/BinaryDecoder.html#decode(byte[])">decode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/BinaryDecoder.html" title="interface in org.apache.commons.codec">BinaryDecoder</A></CODE></DL>

475

</DD>

476

477

<DT>Parameters:<DD><CODE>bytes</CODE> - array of URL safe characters

478

<DT>Returns:<DD>array of original bytes

479

<DT>Throws:

480

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></CODE> - Thrown if URL decoding is unsuccessful</DL>

481

</DD>

482

</DL>

483

<HR>

484

485

486

encode</H3>

487

<PRE>

488

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.223">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString,

489

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

490

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

491

<DL>

492

<DD>Encodes a string into its URL safe form using the specified string charset. Unsafe characters are escaped.

493

494

495

</DL>

496

</DD>

497

498

<DT>Parameters:<DD><CODE>pString</CODE> - string to convert to a URL safe form<DD><CODE>charset</CODE> - the charset for pString

499

<DT>Returns:<DD>URL safe string

500

<DT>Throws:

501

<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</A></CODE> - Thrown if charset is not supported</DL>

502

</DD>

503

</DL>

504

<HR>

505

506

507

encode</H3>

508

<PRE>

509

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.240">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString)

510

throws <A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></PRE>

511

<DL>

512

<DD>Encodes a string into its URL safe form using the default string

513

charset. Unsafe characters are escaped.

514

515

516

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/StringEncoder.html#encode(java.lang.String)">encode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></CODE></DL>

517

</DD>

518

519

<DT>Parameters:<DD><CODE>pString</CODE> - string to convert to a URL safe form

520

<DT>Returns:<DD>URL safe string

521

<DT>Throws:

522

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></CODE> - Thrown if URL encoding is unsuccessful<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#getDefaultCharset()"><CODE>getDefaultCharset()</CODE></A></DL>

523

</DD>

524

</DL>

525

<HR>

526

527

528

decode</H3>

529

<PRE>

530

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.264">decode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString,

531

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

532

throws <A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A>,

533

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

534

<DL>

535

<DD>Decodes a URL safe string into its original form using the

536

specified encoding. Escaped characters are converted back

537

to their original representation.

538

539

540

</DL>

541

</DD>

542

543

<DT>Parameters:<DD><CODE>pString</CODE> - URL safe string to convert into its original form<DD><CODE>charset</CODE> - the original string charset

544

<DT>Returns:<DD>original string

545

<DT>Throws:

546

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></CODE> - Thrown if URL decoding is unsuccessful

547

548

supported</DL>

549

</DD>

550

</DL>

551

<HR>

552

553

554

decode</H3>

555

<PRE>

556

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.282">decode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pString)

557

throws <A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></PRE>

558

<DL>

559

<DD>Decodes a URL safe string into its original form using the default

560

string charset. Escaped characters are converted back to their

561

original representation.

562

563

564

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/StringDecoder.html#decode(java.lang.String)">decode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/StringDecoder.html" title="interface in org.apache.commons.codec">StringDecoder</A></CODE></DL>

565

</DD>

566

567

<DT>Parameters:<DD><CODE>pString</CODE> - URL safe string to convert into its original form

568

<DT>Returns:<DD>original string

569

<DT>Throws:

570

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></CODE> - Thrown if URL decoding is unsuccessful<DT>See Also:<DD><A HREF="../../../../../org/apache/commons/codec/net/URLCodec.html#getDefaultCharset()"><CODE>getDefaultCharset()</CODE></A></DL>

571

</DD>

572

</DL>

573

<HR>

574

575

576

encode</H3>

577

<PRE>

578

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.303">encode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> pObject)

579

throws <A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></PRE>

580

<DL>

581

<DD>Encodes an object into its URL safe form. Unsafe characters are

582

escaped.

583

584

585

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/Encoder.html#encode(java.lang.Object)">encode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A></CODE></DL>

586

</DD>

587

588

<DT>Parameters:<DD><CODE>pObject</CODE> - string to convert to a URL safe form

589

<DT>Returns:<DD>URL safe object

590

<DT>Throws:

591

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></CODE> - Thrown if URL encoding is not

592

applicable to objects of this type or

593

if encoding is unsuccessful</DL>

594

</DD>

595

</DL>

596

<HR>

597

598

599

decode</H3>

600

<PRE>

601

public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <A HREF="../../../../../src-html/org/apache/commons/codec/net/URLCodec.html#line.328">decode</A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> pObject)

602

throws <A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></PRE>

603

<DL>

604

<DD>Decodes a URL safe object into its original form. Escaped characters are converted back to their original

605

representation.

606

607

608

<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/commons/codec/Decoder.html#decode(java.lang.Object)">decode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/Decoder.html" title="interface in org.apache.commons.codec">Decoder</A></CODE></DL>

609

</DD>

610

611

<DT>Parameters:<DD><CODE>pObject</CODE> - URL safe object to convert into its original form

612

<DT>Returns:<DD>original object

613

<DT>Throws:

614

<DD><CODE><A HREF="../../../../../org/apache/commons/codec/DecoderException.html" title="class in org.apache.commons.codec">DecoderException</A></CODE> - Thrown if the argument is not a <code>String</code> or <code>byte[]</code>. Thrown if a failure condition is

615

encountered during the decode process.</DL>

616

</DD>

617

</DL>

618

<HR>

619

620

621

getEncoding</H3>

622

<PRE>

623

624

<DL>

625

<DD>Deprecated. use #getDefaultCharset()

626

627

<DD>The <code>String</code> encoding used for decoding and encoding.

628

629

630

</DL>

631

</DD>

632

633

634

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

635

</DD>

636

</DL>

637

<HR>

638

639

640

getDefaultCharset</H3>

641

<PRE>

642

643

<DL>

644

<DD>The default charset used for string decoding and encoding.

645

646

647

</DL>

648

</DD>

649

650

651

<DT>Returns:<DD>the default string charset.</DL>

652

</DD>

653

</DL>

654

655

<HR>

656

657

658

659

660

661

662

<TR>

663

664

665

666

667

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

668

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

669

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

670

671

672

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

673

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

674

675

</TR>

676

</TABLE>

677

</TD>

678

679

680

</TD>

681

</TR>

682

683

<TR>

684

685

<A HREF="../../../../../org/apache/commons/codec/net/QuotedPrintableCodec.html" title="class in org.apache.commons.codec.net">PREV CLASS</A>

686

NEXT CLASS</TD>

687

688

<A HREF="../../../../../index.html?org/apache/commons/codec/net/URLCodec.html" target="_top">FRAMES</A>

689

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

690

691

<!--

692

if(window==top) {

693

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

694

}

695

//-->

696

</SCRIPT>

697

698

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

699

</NOSCRIPT>

700

701

702

</TD>

703

</TR>

704

<TR>

705

706

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

707

708

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

709

</TR>

710

</TABLE>

711

712

713

714

<HR>

715

716

</BODY>

717

</HTML>

Older »