mxgraph/java/docs/com/mxgraph/util/mxBase64.html at master · JavaScriptIOT/mxgraph

History

559 lines (549 loc) · 24 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<head>

<title>mxBase64 (mxGraph 3.9.8 API Specification)</title>

</head>

<body>

try {

if (location.href.indexOf('is-external=true') == -1) {

parent.document.title="mxBase64 (mxGraph 3.9.8 API Specification)";

}

catch(err) {

}

//-->

var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};

var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};

var altColor = "altColor";

var rowColor = "rowColor";

var tableTab = "tableTab";

var activeTableTab = "activeTableTab";

</script>

<div>JavaScript is disabled on your browser.</div>

</noscript>

</a>

<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>

</a>

<li><a href="../../../overview-summary.html">Overview</a></li>

<li><a href="package-summary.html">Package</a></li>

<li class="navBarCell1Rev">Class</li>

<li><a href="../../../deprecated-list.html">Deprecated</a></li>

<li><a href="../../../index-all.html">Index</a></li>

</ul>

<div class="aboutLanguage"><p><b>mxGraph 3.9.8</b></p></div>

</div>

<li>Prev Class</li>

<li><a href="../../../com/mxgraph/util/mxCellRenderer.html" title="class in com.mxgraph.util"><span class="typeNameLink">Next Class</span></a></li>

</ul>

<li><a href="../../../index.html?com/mxgraph/util/mxBase64.html" target="_top">Frames</a></li>

<li><a href="mxBase64.html" target="_top">No Frames</a></li>

</ul>

<li><a href="../../../allclasses-noframe.html">All Classes</a></li>

</ul>

<div>

allClassesLink = document.getElementById("allclasses_navbar_top");

if(window==top) {

allClassesLink.style.display = "block";

}

else {

allClassesLink.style.display = "none";

}

//-->

</script>

</div>

<div>

<li>Summary: </li>

<li>Nested | </li>

<li>Field | </li>

<li><a href="#constructor.summary">Constr</a> | </li>

<li><a href="#method.summary">Method</a></li>

</ul>

<li>Detail: </li>

<li>Field | </li>

<li><a href="#constructor.detail">Constr</a> | </li>

<li><a href="#method.detail">Method</a></li>

</ul>

</div>

</a></div>

<div class="subTitle">com.mxgraph.util</div>

<h2 title="Class mxBase64" class="title">Class mxBase64</h2>

</div>

<li>java.lang.Object</li>

<li>

<li>com.mxgraph.util.mxBase64</li>

</ul>

</li>

</ul>

<hr>

<br>

<pre>public class <span class="typeNameLabel">mxBase64</span>

extends java.lang.Object</pre>

<div class="block">A very fast and memory efficient class to encode and decode to and from BASE64 in full accordance

with RFC 2045.<br><br>

On Windows XP sp1 with 1.4.2_04 and later ;), this encoder and decoder is about 10 times faster

on small arrays (10 - 1000 bytes) and 2-3 times as fast on larger arrays (10000 - 1000000 bytes)

compared to <code>sun.misc.Encoder()/Decoder()</code>.<br><br>

On byte arrays the encoder is about 20% faster than Jakarta Commons Base64 Codec for encode and

about 50% faster for decoding large arrays. This implementation is about twice as fast on very small

arrays (&lt 30 bytes). If source/destination is a <code>String</code> this

version is about three times as fast due to the fact that the Commons Codec result has to be recoded

to a <code>String</code> from <code>byte[]</code>, which is very expensive.<br><br>

This encode/decode algorithm doesn't create any temporary arrays as many other codecs do, it only

allocates the resulting array. This produces less garbage and it is possible to handle arrays twice

as large as algorithms that create a temporary array. (E.g. Jakarta Commons Codec). It is unknown

whether Sun's <code>sun.misc.Encoder()/Decoder()</code> produce temporary arrays but since performance

is quite low it probably does.<br><br>

The encoder produces the same output as the Sun one except that the Sun's encoder appends

a trailing line separator if the last character isn't a pad. Unclear why but it only adds to the

length and is probably a side effect. Both are in conformance with RFC 2045 though.<br>

Commons codec seem to always att a trailing line separator.<br><br>

The encode/decode method pairs (types) come in three versions with the <b>exact</b> same algorithm and

thus a lot of code redundancy. This is to not create any temporary arrays for transcoding to/from different

format types. The methods not used can simply be commented out.<br><br>

There is also a "fast" version of all decode methods that works the same way as the normal ones, but

har a few demands on the decoded input. Normally though, these fast verions should be used if the source if

the input is known and it hasn't bee tampered with.<br><br>

If you find the code useful or you find a bug, please send me a note at base64 @ miginfocom . com.

Licence (BSD):

==============

Redistribution and use in source and binary forms, with or without modification,

are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list

of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this

list of conditions and the following disclaimer in the documentation and/or other

materials provided with the distribution.

Neither the name of the MiG InfoCom AB nor the names of its contributors may be

used to endorse or promote products derived from this software without specific

prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,

INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,

OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY

OF SUCH DAMAGE.</div>

</li>

</ul>

</div>

</a>

<h3>Constructor Summary</h3>

<caption><span>Constructors</span><span class="tabEnd"> </span></caption>

<tr>

<th class="colOne" scope="col">Constructor and Description</th>

</tr>

<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#mxBase64--">mxBase64</a></span>()</code> </td>

</tr>

</table>

</li>

</ul>

</a>

<h3>Method Summary</h3>

<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>

<tr>

<th class="colFirst" scope="col">Modifier and Type</th>

<th class="colLast" scope="col">Method and Description</th>

</tr>

<td class="colFirst"><code>static byte[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#decode-byte:A-">decode</a></span>(byte[] sArr)</code>

<div class="block">Decodes a BASE64 encoded byte array.</div>

</td>

</tr>

<td class="colFirst"><code>static byte[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#decode-char:A-">decode</a></span>(char[] sArr)</code>

<div class="block">Decodes a BASE64 encoded char array.</div>

</td>

</tr>

<td class="colFirst"><code>static byte[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#decode-java.lang.String-">decode</a></span>(java.lang.String str)</code>

<div class="block">Decodes a BASE64 encoded <code>String</code>.</div>

</td>

</tr>

<td class="colFirst"><code>static byte[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#decodeFast-byte:A-">decodeFast</a></span>(byte[] sArr)</code>

<div class="block">Decodes a BASE64 encoded byte array that is known to be resonably well formatted.</div>

</td>

</tr>

<td class="colFirst"><code>static byte[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#decodeFast-char:A-">decodeFast</a></span>(char[] sArr)</code>

<div class="block">Decodes a BASE64 encoded char array that is known to be resonably well formatted.</div>

</td>

</tr>

<td class="colFirst"><code>static byte[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#decodeFast-java.lang.String-">decodeFast</a></span>(java.lang.String s)</code>

<div class="block">Decodes a BASE64 encoded string that is known to be resonably well formatted.</div>

</td>

</tr>

<td class="colFirst"><code>static byte[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#encodeToByte-byte:A-boolean-">encodeToByte</a></span>(byte[] sArr,

boolean lineSep)</code>

<div class="block">Encodes a raw byte array into a BASE64 <code>byte[]</code> representation i accordance with RFC 2045.</div>

</td>

</tr>

<td class="colFirst"><code>static char[]</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#encodeToChar-byte:A-boolean-">encodeToChar</a></span>(byte[] sArr,

boolean lineSep)</code>

<div class="block">Encodes a raw byte array into a BASE64 <code>char[]</code> representation i accordance with RFC 2045.</div>

</td>

</tr>

<td class="colFirst"><code>static java.lang.String</code></td>

<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/util/mxBase64.html#encodeToString-byte:A-boolean-">encodeToString</a></span>(byte[] sArr,

boolean lineSep)</code>

<div class="block">Encodes a raw byte array into a BASE64 <code>String</code> representation i accordance with RFC 2045.</div>

</td>

</tr>

</table>

</a>

<h3>Methods inherited from class java.lang.Object</h3>

<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>

</ul>

</li>

</ul>

</li>

</ul>

</div>

</a>

<h3>Constructor Detail</h3>

</a>

<h4>mxBase64</h4>

<pre>public mxBase64()</pre>

</li>

</ul>

</li>

</ul>

</a>

<h3>Method Detail</h3>

</a>

<h4>encodeToChar</h4>

<pre>public static final char[] encodeToChar(byte[] sArr,

boolean lineSep)</pre>

<div class="block">Encodes a raw byte array into a BASE64 <code>char[]</code> representation i accordance with RFC 2045.</div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sArr</code> - The bytes to convert. If <code>null</code> or length 0 an empty array will be returned.</dd>

<dd><code>lineSep</code> - Optional "\r\n" after 76 characters, unless end of file.<br>

No line separator will be in breach of RFC 2045 which specifies max 76 per line but will be a

little faster.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>A BASE64 encoded array. Never <code>null</code>.</dd>

</dl>

</li>

</ul>

</a>

<h4>decode</h4>

<pre>public static final byte[] decode(char[] sArr)</pre>

<div class="block">Decodes a BASE64 encoded char array. All illegal characters will be ignored and can handle both arrays with

and without line separators.</div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sArr</code> - The source array. <code>null</code> or length 0 will return an empty array.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>The decoded array of bytes. May be of length 0. Will be <code>null</code> if the legal characters

(including '=') isn't divideable by 4. (I.e. definitely corrupted).</dd>

</dl>

</li>

</ul>

</a>

<h4>decodeFast</h4>

<pre>public static final byte[] decodeFast(char[] sArr)</pre>

<div class="block">Decodes a BASE64 encoded char array that is known to be resonably well formatted. The method is about twice as

fast as <a href="../../../com/mxgraph/util/mxBase64.html#decode-char:A-"><code>decode(char[])</code></a>. The preconditions are:<br>

+ The array must have a line length of 76 chars OR no line separators at all (one line).<br>

+ Line separator must be "\r\n", as specified in RFC 2045

+ The array must not contain illegal characters within the encoded string<br>

+ The array CAN have illegal characters at the beginning and end, those will be dealt with appropriately.<br></div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sArr</code> - The source array. Length 0 will return an empty array. <code>null</code> will throw an exception.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>The decoded array of bytes. May be of length 0.</dd>

</dl>

</li>

</ul>

</a>

<h4>encodeToByte</h4>

<pre>public static final byte[] encodeToByte(byte[] sArr,

boolean lineSep)</pre>

<div class="block">Encodes a raw byte array into a BASE64 <code>byte[]</code> representation i accordance with RFC 2045.</div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sArr</code> - The bytes to convert. If <code>null</code> or length 0 an empty array will be returned.</dd>

<dd><code>lineSep</code> - Optional "\r\n" after 76 characters, unless end of file.<br>

No line separator will be in breach of RFC 2045 which specifies max 76 per line but will be a

little faster.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>A BASE64 encoded array. Never <code>null</code>.</dd>

</dl>

</li>

</ul>

</a>

<h4>decode</h4>

<pre>public static final byte[] decode(byte[] sArr)</pre>

<div class="block">Decodes a BASE64 encoded byte array. All illegal characters will be ignored and can handle both arrays with

and without line separators.</div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sArr</code> - The source array. Length 0 will return an empty array. <code>null</code> will throw an exception.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>The decoded array of bytes. May be of length 0. Will be <code>null</code> if the legal characters

(including '=') isn't divideable by 4. (I.e. definitely corrupted).</dd>

</dl>

</li>

</ul>

</a>

<h4>decodeFast</h4>

<pre>public static final byte[] decodeFast(byte[] sArr)</pre>

<div class="block">Decodes a BASE64 encoded byte array that is known to be resonably well formatted. The method is about twice as

fast as <a href="../../../com/mxgraph/util/mxBase64.html#decode-byte:A-"><code>decode(byte[])</code></a>. The preconditions are:<br>

+ The array must have a line length of 76 chars OR no line separators at all (one line).<br>

+ Line separator must be "\r\n", as specified in RFC 2045

+ The array must not contain illegal characters within the encoded string<br>

+ The array CAN have illegal characters at the beginning and end, those will be dealt with appropriately.<br></div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sArr</code> - The source array. Length 0 will return an empty array. <code>null</code> will throw an exception.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>The decoded array of bytes. May be of length 0.</dd>

</dl>

</li>

</ul>

</a>

<h4>encodeToString</h4>

<pre>public static final java.lang.String encodeToString(byte[] sArr,

boolean lineSep)</pre>

<div class="block">Encodes a raw byte array into a BASE64 <code>String</code> representation i accordance with RFC 2045.</div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sArr</code> - The bytes to convert. If <code>null</code> or length 0 an empty array will be returned.</dd>

<dd><code>lineSep</code> - Optional "\r\n" after 76 characters, unless end of file.<br>

No line separator will be in breach of RFC 2045 which specifies max 76 per line but will be a

little faster.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>A BASE64 encoded array. Never <code>null</code>.</dd>

</dl>

</li>

</ul>

</a>

<h4>decode</h4>

<pre>public static final byte[] decode(java.lang.String str)</pre>

<div class="block">Decodes a BASE64 encoded <code>String</code>. All illegal characters will be ignored and can handle both strings with

and without line separators.<br>

<b>Note!</b> It can be up to about 2x the speed to call <code>decode(str.toCharArray())</code> instead. That

will create a temporary array though. This version will use <code>str.charAt(i)</code> to iterate the string.</div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>str</code> - The source string. <code>null</code> or length 0 will return an empty array.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>The decoded array of bytes. May be of length 0. Will be <code>null</code> if the legal characters

(including '=') isn't divideable by 4. (I.e. definitely corrupted).</dd>

</dl>

</li>

</ul>

</a>

<h4>decodeFast</h4>

<pre>public static final byte[] decodeFast(java.lang.String s)</pre>

<div class="block">Decodes a BASE64 encoded string that is known to be resonably well formatted. The method is about twice as

fast as <a href="../../../com/mxgraph/util/mxBase64.html#decode-java.lang.String-"><code>decode(String)</code></a>. The preconditions are:<br>

+ The array must have a line length of 76 chars OR no line separators at all (one line).<br>

+ Line separator must be "\r\n", as specified in RFC 2045

+ The array must not contain illegal characters within the encoded string<br>

+ The array CAN have illegal characters at the beginning and end, those will be dealt with appropriately.<br></div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>s</code> - The source string. Length 0 will return an empty array. <code>null</code> will throw an exception.</dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>The decoded array of bytes. May be of length 0.</dd>

</dl>

</li>

</ul>

</li>

</ul>

</li>

</ul>

</div>

</a>

<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>

</a>

<li><a href="../../../overview-summary.html">Overview</a></li>

<li><a href="package-summary.html">Package</a></li>

<li class="navBarCell1Rev">Class</li>

<li><a href="../../../deprecated-list.html">Deprecated</a></li>

<li><a href="../../../index-all.html">Index</a></li>

</ul>

<div class="aboutLanguage"><p><b>mxGraph 3.9.8</b></p></div>

</div>

<li>Prev Class</li>

<li><a href="../../../com/mxgraph/util/mxCellRenderer.html" title="class in com.mxgraph.util"><span class="typeNameLink">Next Class</span></a></li>

</ul>

<li><a href="../../../index.html?com/mxgraph/util/mxBase64.html" target="_top">Frames</a></li>

<li><a href="mxBase64.html" target="_top">No Frames</a></li>

</ul>

<li><a href="../../../allclasses-noframe.html">All Classes</a></li>

</ul>

<div>

allClassesLink = document.getElementById("allclasses_navbar_bottom");

if(window==top) {

allClassesLink.style.display = "block";

}

else {

allClassesLink.style.display = "none";

}

//-->

</script>

</div>

<div>

<li>Summary: </li>

<li>Nested | </li>

<li>Field | </li>

<li><a href="#constructor.summary">Constr</a> | </li>

<li><a href="#method.summary">Method</a></li>

</ul>

<li>Detail: </li>

<li>Field | </li>

<li><a href="#constructor.detail">Constr</a> | </li>

<li><a href="#method.detail">Method</a></li>

</ul>

</div>

</a></div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

mxBase64.html

Latest commit

History

mxBase64.html

File metadata and controls