java/javase/note/docs/api/java.base/java/io/File.html at master · ziyinjava/java

History

2659 lines (2586 loc) · 135 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

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE HTML>

<head>

<!--[if IE]>

<![endif]-->

</head>

<body>

try {

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

parent.document.title="File (Java SE 12 & JDK 12 )";

}

catch(err) {

}

//-->

var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":9,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":42};

var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};

var altColor = "altColor";

var rowColor = "rowColor";

var tableTab = "tableTab";

var activeTableTab = "activeTableTab";

var pathtoroot = "../../../";

var useModuleDirectories = true;

loadScripts(document, 'script');</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="../../../index.html">Overview</a></li>

<li><a href="../../module-summary.html">Module</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-files/index-1.html">Index</a></li>

</ul>

</div>

<div>

<li>Summary: </li>

<li>Nested | </li>

<li><a href="#field.summary">Field</a> | </li>

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

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

</ul>

<li>Detail: </li>

<li><a href="#field.detail">Field</a> | </li>

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

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

</ul>

</div>

<li><label for="search">SEARCH:</label>

</li>

</ul>

</div>

</a>

</div>

$('.navPadding').css('padding-top', $('.fixedNav').css("height"));

//-->

</script>

</nav>

</header>

<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.base</a></div>

<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">java.io</a></div>

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

</div>

<li><a href="../lang/Object.html" title="class in java.lang">java.lang.Object</a></li>

<li>

</ul>

</li>

</ul>

<dl>

<dt>All Implemented Interfaces:</dt>

<dd><code><a href="Serializable.html" title="interface in java.io">Serializable</a></code>, <code><a href="../lang/Comparable.html" title="interface in java.lang">Comparable</a><<a href="File.html" title="class in java.io">File</a>></code></dd>

</dl>

<hr>

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

extends <a href="../lang/Object.html" title="class in java.lang">Object</a>

implements <a href="Serializable.html" title="interface in java.io">Serializable</a>, <a href="../lang/Comparable.html" title="interface in java.lang">Comparable</a><<a href="File.html" title="class in java.io">File</a>></pre>

<div class="block">An abstract representation of file and directory pathnames.

<p> User interfaces and operating systems use system-dependent <em>pathname

strings</em> to name files and directories. This class presents an

abstract, system-independent view of hierarchical pathnames. An

<em>abstract pathname</em> has two components:

<ol>

<li> An optional system-dependent <em>prefix</em> string,

such as a disk-drive specifier, <code>"/"</code> for the UNIX root

directory, or <code>"\\\\"</code> for a Microsoft Windows UNC pathname, and

<li> A sequence of zero or more string <em>names</em>.

</ol>

The first name in an abstract pathname may be a directory name or, in the

case of Microsoft Windows UNC pathnames, a hostname. Each subsequent name

in an abstract pathname denotes a directory; the last name may denote

either a directory or a file. The <em>empty</em> abstract pathname has no

prefix and an empty name sequence.

<p> The conversion of a pathname string to or from an abstract pathname is

inherently system-dependent. When an abstract pathname is converted into a

pathname string, each name is separated from the next by a single copy of

the default <em>separator character</em>. The default name-separator

character is defined by the system property <code>file.separator</code>, and

is made available in the public static fields <a href="#separator"><code>separator</code></a> and <a href="#separatorChar"><code>separatorChar</code></a> of this class.

When a pathname string is converted into an abstract pathname, the names

within it may be separated by the default name-separator character or by any

other name-separator character that is supported by the underlying system.

<p> A pathname, whether abstract or in string form, may be either

<em>absolute</em> or <em>relative</em>. An absolute pathname is complete in

that no other information is required in order to locate the file that it

denotes. A relative pathname, in contrast, must be interpreted in terms of

information taken from some other pathname. By default the classes in the

<code>java.io</code> package always resolve relative pathnames against the

current user directory. This directory is named by the system property

<code>user.dir</code>, and is typically the directory in which the Java

virtual machine was invoked.

<p> The <em>parent</em> of an abstract pathname may be obtained by invoking

the <a href="#getParent()"><code>getParent()</code></a> method of this class and consists of the pathname's

prefix and each name in the pathname's name sequence except for the last.

Each directory's absolute pathname is an ancestor of any <code>File</code>

object with an absolute abstract pathname which begins with the directory's

absolute pathname. For example, the directory denoted by the abstract

pathname <code>"/usr"</code> is an ancestor of the directory denoted by the

pathname <code>"/usr/local/bin"</code>.

<p> The prefix concept is used to handle root directories on UNIX platforms,

and drive specifiers, root directories and UNC pathnames on Microsoft Windows platforms,

as follows:

<ul>

<li> For UNIX platforms, the prefix of an absolute pathname is always

<code>"/"</code>. Relative pathnames have no prefix. The abstract pathname

denoting the root directory has the prefix <code>"/"</code> and an empty

name sequence.

<li> For Microsoft Windows platforms, the prefix of a pathname that contains a drive

specifier consists of the drive letter followed by <code>":"</code> and

possibly followed by <code>"\\"</code> if the pathname is absolute. The

prefix of a UNC pathname is <code>"\\\\"</code>; the hostname and the share

name are the first two names in the name sequence. A relative pathname that

does not specify a drive has no prefix.

</ul>

<p> Instances of this class may or may not denote an actual file-system

object such as a file or a directory. If it does denote such an object

then that object resides in a <i>partition</i>. A partition is an

operating system-specific portion of storage for a file system. A single

storage device (e.g. a physical disk-drive, flash memory, CD-ROM) may

contain multiple partitions. The object, if any, will reside on the

partition <a id="partName">named</a> by some ancestor of the absolute

form of this pathname.

<p> A file system may implement restrictions to certain operations on the

actual file-system object, such as reading, writing, and executing. These

restrictions are collectively known as <i>access permissions</i>. The file

system may have multiple sets of access permissions on a single object.

For example, one set may apply to the object's <i>owner</i>, and another

may apply to all other users. The access permissions on an object may

cause some methods in this class to fail.

<p> Instances of the <code>File</code> class are immutable; that is, once

created, the abstract pathname represented by a <code>File</code> object

will never change.

<h3>Interoperability with <code>java.nio.file</code> package</h3>

package defines interfaces and classes for the Java virtual machine to access

files, file attributes, and file systems. This API may be used to overcome

many of the limitations of the <code>java.io.File</code> class.

The <a href="#toPath()"><code>toPath</code></a> method may be used to obtain a <a href="../nio/file/Path.html" title="interface in java.nio.file"><code>Path</code></a> that uses the abstract path represented by a <code>File</code> object to

locate a file. The resulting <code>Path</code> may be used with the <a href="../nio/file/Files.html" title="class in java.nio.file"><code>Files</code></a> class to provide more efficient and extensive access to

additional file operations, file attributes, and I/O exceptions to help

diagnose errors when an operation on a file fails.</div>

<dl>

<dt><span class="simpleTagLabel">Since:</span></dt>

<dd><a href="../../../serialized-form.html#java.io.File">Serialized Form</a></dd>

</dl>

</li>

</ul>

</div>

</a>

<h3>Field Summary</h3>

<table>

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

<tr>

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

<th class="colSecond" scope="col">Field</th>

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

</tr>

<tbody>

<td class="colFirst"><code>static <a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pathSeparator">pathSeparator</a></span></code></th>

<div class="block">The system-dependent path-separator character, represented as a string

for convenience.</div>

</td>

</tr>

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

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pathSeparatorChar">pathSeparatorChar</a></span></code></th>

<div class="block">The system-dependent path-separator character.</div>

</td>

</tr>

<td class="colFirst"><code>static <a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#separator">separator</a></span></code></th>

<div class="block">The system-dependent default name-separator character, represented as a

string for convenience.</div>

</td>

</tr>

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

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#separatorChar">separatorChar</a></span></code></th>

<div class="block">The system-dependent default name-separator character.</div>

</td>

</tr>

</tbody>

</table>

</div>

</li>

</ul>

</section>

</a>

<h3>Constructor Summary</h3>

<table>

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

<tr>

<th class="colFirst" scope="col">Constructor</th>

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

</tr>

<tbody>

<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.io.File,java.lang.String)">File</a></span>(<a href="File.html" title="class in java.io">File</a> parent,

<a href="../lang/String.html" title="class in java.lang">String</a> child)</code></th>

<div class="block">Creates a new <code>File</code> instance from a parent abstract

pathname and a child pathname string.</div>

</td>

</tr>

<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">File</a></span>(<a href="../lang/String.html" title="class in java.lang">String</a> pathname)</code></th>

<div class="block">Creates a new <code>File</code> instance by converting the given

pathname string into an abstract pathname.</div>

</td>

</tr>

<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String)">File</a></span>(<a href="../lang/String.html" title="class in java.lang">String</a> parent,

<a href="../lang/String.html" title="class in java.lang">String</a> child)</code></th>

<div class="block">Creates a new <code>File</code> instance from a parent pathname string

and a child pathname string.</div>

</td>

</tr>

<div class="block">Creates a new <code>File</code> instance by converting the given

<code>file:</code> URI into an abstract pathname.</div>

</td>

</tr>

</tbody>

</table>

</div>

</li>

</ul>

</section>

</a>

<h3>Method Summary</h3>

<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div>

<tr>

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

<th class="colSecond" scope="col">Method</th>

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

</tr>

<tbody>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canExecute()">canExecute</a></span>()</code></th>

<div class="block">Tests whether the application can execute the file denoted by this

abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canRead()">canRead</a></span>()</code></th>

<div class="block">Tests whether the application can read the file denoted by this

abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canWrite()">canWrite</a></span>()</code></th>

<div class="block">Tests whether the application can modify the file denoted by this

abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareTo(java.io.File)">compareTo</a></span>(<a href="File.html" title="class in java.io">File</a> pathname)</code></th>

<div class="block">Compares two abstract pathnames lexicographically.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createNewFile()">createNewFile</a></span>()</code></th>

<div class="block">Atomically creates a new, empty file named by this abstract pathname if

and only if a file with this name does not yet exist.</div>

</td>

</tr>

<td class="colFirst"><code>static <a href="File.html" title="class in java.io">File</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createTempFile(java.lang.String,java.lang.String)">createTempFile</a></span>(<a href="../lang/String.html" title="class in java.lang">String</a> prefix,

<a href="../lang/String.html" title="class in java.lang">String</a> suffix)</code></th>

<div class="block">Creates an empty file in the default temporary-file directory, using

the given prefix and suffix to generate its name.</div>

</td>

</tr>

<td class="colFirst"><code>static <a href="File.html" title="class in java.io">File</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createTempFile(java.lang.String,java.lang.String,java.io.File)">createTempFile</a></span>(<a href="../lang/String.html" title="class in java.lang">String</a> prefix,

<a href="../lang/String.html" title="class in java.lang">String</a> suffix,

<a href="File.html" title="class in java.io">File</a> directory)</code></th>

<div class="block"> Creates a new empty file in the specified directory, using the

given prefix and suffix strings to generate its name.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete()">delete</a></span>()</code></th>

<div class="block">Deletes the file or directory denoted by this abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteOnExit()">deleteOnExit</a></span>()</code></th>

<div class="block">Requests that the file or directory denoted by this abstract

pathname be deleted when the virtual machine terminates.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>(<a href="../lang/Object.html" title="class in java.lang">Object</a> obj)</code></th>

<div class="block">Tests this abstract pathname for equality with the given object.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exists()">exists</a></span>()</code></th>

<div class="block">Tests whether the file or directory denoted by this abstract pathname

exists.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAbsoluteFile()">getAbsoluteFile</a></span>()</code></th>

<div class="block">Returns the absolute form of this abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAbsolutePath()">getAbsolutePath</a></span>()</code></th>

<div class="block">Returns the absolute pathname string of this abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCanonicalFile()">getCanonicalFile</a></span>()</code></th>

<div class="block">Returns the canonical form of this abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCanonicalPath()">getCanonicalPath</a></span>()</code></th>

<div class="block">Returns the canonical pathname string of this abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFreeSpace()">getFreeSpace</a></span>()</code></th>

<div class="block">Returns the number of unallocated bytes in the partition <a href="#partName">named</a> by this abstract path name.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>

<div class="block">Returns the name of the file or directory denoted by this abstract

pathname.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th>

<div class="block">Returns the pathname string of this abstract pathname's parent, or

<code>null</code> if this pathname does not name a parent directory.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParentFile()">getParentFile</a></span>()</code></th>

<div class="block">Returns the abstract pathname of this abstract pathname's parent,

or <code>null</code> if this pathname does not name a parent

directory.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPath()">getPath</a></span>()</code></th>

<div class="block">Converts this abstract pathname into a pathname string.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalSpace()">getTotalSpace</a></span>()</code></th>

<div class="block">Returns the size of the partition <a href="#partName">named</a> by this

abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsableSpace()">getUsableSpace</a></span>()</code></th>

<div class="block">Returns the number of bytes available to this virtual machine on the

partition <a href="#partName">named</a> by this abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>

<div class="block">Computes a hash code for this abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAbsolute()">isAbsolute</a></span>()</code></th>

<div class="block">Tests whether this abstract pathname is absolute.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDirectory()">isDirectory</a></span>()</code></th>

<div class="block">Tests whether the file denoted by this abstract pathname is a

directory.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFile()">isFile</a></span>()</code></th>

<div class="block">Tests whether the file denoted by this abstract pathname is a normal

file.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isHidden()">isHidden</a></span>()</code></th>

<div class="block">Tests whether the file named by this abstract pathname is a hidden

file.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lastModified()">lastModified</a></span>()</code></th>

<div class="block">Returns the time that the file denoted by this abstract pathname was

last modified.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#length()">length</a></span>()</code></th>

<div class="block">Returns the length of the file denoted by this abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a>[]</code></td>

<div class="block">Returns an array of strings naming the files and directories in the

directory denoted by this abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a>[]</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#list(java.io.FilenameFilter)">list</a></span>(<a href="FilenameFilter.html" title="interface in java.io">FilenameFilter</a> filter)</code></th>

<div class="block">Returns an array of strings naming the files and directories in the

directory denoted by this abstract pathname that satisfy the specified

filter.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listFiles()">listFiles</a></span>()</code></th>

<div class="block">Returns an array of abstract pathnames denoting the files in the

directory denoted by this abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listFiles(java.io.FileFilter)">listFiles</a></span>(<a href="FileFilter.html" title="interface in java.io">FileFilter</a> filter)</code></th>

<div class="block">Returns an array of abstract pathnames denoting the files and

directories in the directory denoted by this abstract pathname that

satisfy the specified filter.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listFiles(java.io.FilenameFilter)">listFiles</a></span>(<a href="FilenameFilter.html" title="interface in java.io">FilenameFilter</a> filter)</code></th>

<div class="block">Returns an array of abstract pathnames denoting the files and

directories in the directory denoted by this abstract pathname that

satisfy the specified filter.</div>

</td>

</tr>

<td class="colFirst"><code>static <a href="File.html" title="class in java.io">File</a>[]</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listRoots()">listRoots</a></span>()</code></th>

<div class="block">List the available filesystem roots.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mkdir()">mkdir</a></span>()</code></th>

<div class="block">Creates the directory named by this abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mkdirs()">mkdirs</a></span>()</code></th>

<div class="block">Creates the directory named by this abstract pathname, including any

necessary but nonexistent parent directories.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameTo(java.io.File)">renameTo</a></span>(<a href="File.html" title="class in java.io">File</a> dest)</code></th>

<div class="block">Renames the file denoted by this abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExecutable(boolean)">setExecutable</a></span>(boolean executable)</code></th>

<div class="block">A convenience method to set the owner's execute permission for this

abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExecutable(boolean,boolean)">setExecutable</a></span>(boolean executable,

boolean ownerOnly)</code></th>

<div class="block">Sets the owner's or everybody's execute permission for this abstract

pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLastModified(long)">setLastModified</a></span>(long time)</code></th>

<div class="block">Sets the last-modified time of the file or directory named by this

abstract pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadable(boolean)">setReadable</a></span>(boolean readable)</code></th>

<div class="block">A convenience method to set the owner's read permission for this abstract

pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadable(boolean,boolean)">setReadable</a></span>(boolean readable,

boolean ownerOnly)</code></th>

<div class="block">Sets the owner's or everybody's read permission for this abstract

pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadOnly()">setReadOnly</a></span>()</code></th>

<div class="block">Marks the file or directory named by this abstract pathname so that

only read operations are allowed.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWritable(boolean)">setWritable</a></span>(boolean writable)</code></th>

<div class="block">A convenience method to set the owner's write permission for this abstract

pathname.</div>

</td>

</tr>

<td class="colFirst"><code>boolean</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWritable(boolean,boolean)">setWritable</a></span>(boolean writable,

boolean ownerOnly)</code></th>

<div class="block">Sets the owner's or everybody's write permission for this abstract

pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toPath()">toPath</a></span>()</code></th>

<div class="block">Returns a <a href="../nio/file/Path.html" title="interface in java.nio.file"><code>java.nio.file.Path</code></a> object constructed from

this abstract path.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>

<div class="block">Returns the pathname string of this abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toURI()">toURI</a></span>()</code></th>

<div class="block">Constructs a <code>file:</code> URI that represents this abstract pathname.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toURL()">toURL</a></span>()</code></th>

<div class="block"><span class="deprecatedLabel">Deprecated.</span>

<div class="deprecationComment">This method does not automatically escape characters that

are illegal in URLs.</div>

</div>

</td>

</tr>

</tbody>

</table>

</div>

</a>

<h3>Methods declared in class java.lang.<a href="../lang/Object.html" title="class in java.lang">Object</a></h3>

<code><a href="../lang/Object.html#clone()">clone</a>, <a href="../lang/Object.html#finalize()">finalize</a>, <a href="../lang/Object.html#getClass()">getClass</a>, <a href="../lang/Object.html#notify()">notify</a>, <a href="../lang/Object.html#notifyAll()">notifyAll</a>, <a href="../lang/Object.html#wait()">wait</a>, <a href="../lang/Object.html#wait(long)">wait</a>, <a href="../lang/Object.html#wait(long,int)">wait</a></code></li>

</ul>

</li>

</ul>

</section>

</li>

</ul>

</div>

</a>

<h3>Field Detail</h3>

</a>

<h4>separatorChar</h4>

<pre>public static final char separatorChar</pre>

<div class="block">The system-dependent default name-separator character. This field is

initialized to contain the first character of the value of the system

property <code>file.separator</code>. On UNIX systems the value of this

field is <code>'/'</code>; on Microsoft Windows systems it is <code>'\\'</code>.</div>

<dl>

<dd><a href="../lang/System.html#getProperty(java.lang.String)"><code>System.getProperty(java.lang.String)</code></a></dd>

</dl>

</li>

</ul>

</a>

<h4>separator</h4>

<pre>public static final <a href="../lang/String.html" title="class in java.lang">String</a> separator</pre>

<div class="block">The system-dependent default name-separator character, represented as a

string for convenience. This string contains a single character, namely

<a href="#separatorChar"><code>separatorChar</code></a>.</div>

</li>

</ul>

</a>

<h4>pathSeparatorChar</h4>

<pre>public static final char pathSeparatorChar</pre>

<div class="block">The system-dependent path-separator character. This field is

initialized to contain the first character of the value of the system

property <code>path.separator</code>. This character is used to

separate filenames in a sequence of files given as a <em>path list</em>.

On UNIX systems, this character is <code>':'</code>; on Microsoft Windows systems it

is <code>';'</code>.</div>

<dl>

<dd><a href="../lang/System.html#getProperty(java.lang.String)"><code>System.getProperty(java.lang.String)</code></a></dd>

</dl>

</li>

</ul>

</a>

<h4>pathSeparator</h4>

<pre>public static final <a href="../lang/String.html" title="class in java.lang">String</a> pathSeparator</pre>

<div class="block">The system-dependent path-separator character, represented as a string

for convenience. This string contains a single character, namely

<a href="#pathSeparatorChar"><code>pathSeparatorChar</code></a>.</div>

</li>

</ul>

</li>

</ul>

</section>

</a>

<h3>Constructor Detail</h3>

<a id="<init>(java.lang.String)">

</a>

<pre>public File(<a href="../lang/String.html" title="class in java.lang">String</a> pathname)</pre>

<div class="block">Creates a new <code>File</code> instance by converting the given

pathname string into an abstract pathname. If the given string is

the empty string, then the result is the empty abstract pathname.</div>

<dl>

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

<dd><code>pathname</code> - A pathname string</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - If the <code>pathname</code> argument is <code>null</code></dd>

</dl>

</li>

</ul>

<a id="<init>(java.lang.String,java.lang.String)">

</a>

<pre>public File(<a href="../lang/String.html" title="class in java.lang">String</a> parent,

<a href="../lang/String.html" title="class in java.lang">String</a> child)</pre>

<div class="block">Creates a new <code>File</code> instance from a parent pathname string

and a child pathname string.

<p> If <code>parent</code> is <code>null</code> then the new

<code>File</code> instance is created as if by invoking the

single-argument <code>File</code> constructor on the given

<code>child</code> pathname string.

<p> Otherwise the <code>parent</code> pathname string is taken to denote

a directory, and the <code>child</code> pathname string is taken to

denote either a directory or a file. If the <code>child</code> pathname

string is absolute then it is converted into a relative pathname in a

system-dependent way. If <code>parent</code> is the empty string then

the new <code>File</code> instance is created by converting

<code>child</code> into an abstract pathname and resolving the result

against a system-dependent default directory. Otherwise each pathname

string is converted into an abstract pathname and the child abstract

pathname is resolved against the parent.</div>

<dl>

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

<dd><code>parent</code> - The parent pathname string</dd>

<dd><code>child</code> - The child pathname string</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - If <code>child</code> is <code>null</code></dd>

</dl>

</li>

</ul>

<a id="<init>(java.io.File,java.lang.String)">

</a>

<pre>public File(<a href="File.html" title="class in java.io">File</a> parent,

<a href="../lang/String.html" title="class in java.lang">String</a> child)</pre>

<div class="block">Creates a new <code>File</code> instance from a parent abstract

pathname and a child pathname string.

<p> If <code>parent</code> is <code>null</code> then the new

<code>File</code> instance is created as if by invoking the

single-argument <code>File</code> constructor on the given

<code>child</code> pathname string.

<p> Otherwise the <code>parent</code> abstract pathname is taken to

denote a directory, and the <code>child</code> pathname string is taken

to denote either a directory or a file. If the <code>child</code>

pathname string is absolute then it is converted into a relative

pathname in a system-dependent way. If <code>parent</code> is the empty

abstract pathname then the new <code>File</code> instance is created by

converting <code>child</code> into an abstract pathname and resolving

the result against a system-dependent default directory. Otherwise each

pathname string is converted into an abstract pathname and the child

abstract pathname is resolved against the parent.</div>

<dl>

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

<dd><code>parent</code> - The parent abstract pathname</dd>

<dd><code>child</code> - The child pathname string</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - If <code>child</code> is <code>null</code></dd>

</dl>

</li>

</ul>

</a>

<pre>public File(<a href="../net/URI.html" title="class in java.net">URI</a> uri)</pre>

<div class="block">Creates a new <code>File</code> instance by converting the given

<code>file:</code> URI into an abstract pathname.

<p> The exact form of a <code>file:</code> URI is system-dependent, hence

the transformation performed by this constructor is also

system-dependent.

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

File.html

Latest commit

History

File.html

File metadata and controls