全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス

クラス java.io.File 

java.lang.Object
   |
   +----java.io.File
public class File
extends Object
implements Serializable
このクラスのインスタンスは、ホストファイルシステム上でのファイル名、またはディレクトリ名を表現します。ファイルはパス名により特定され、パス名には絶対パス名と現在のワーキングディレクトリに対する相対パス名とがあります。パス名はホストプラットフォームの規則に従って命名されなければなりません。

ファイルとパスの命名法はマシンに依存した複雑なものであるため、これを一段抽象化してマシンに依存しない方法で取り扱うためにFileクラスが提供されています。

ファイル名やパスが使用されるときはいつでも、そのホストのファイル命名規則が使われていることに注意してください。

Variable Index

o pathSeparator
システムに依存するパスセパレーター文字列。
o pathSeparatorChar
システムに依存するパスセパレーター文字。
o separator
システムに依存するパスセパレーター文字。
o separatorChar
システムに依存するパスセパレーター文字列。

Constructor Index

o File(File, String)
指定されたディレクトリ上の、指定された名前を持つファイルを表現する File インスタンスを作成する。
o File(String)
ファイルパスが引数として与えられたファイルを表現する File インスタンスを作成する。
o File(String, String)
パス名が、指定されたディレクトリパスと、セパレーター文字と、 name 引数で与えられるファイルを表現する File インスタンスを作成する。

Method Index

o canRead()
アプリケーションが指定したファイルから読み込み可能かをテストする。
o canWrite()
アプリケーションがファイルに書き込み可能かをテストする。
o delete()
オブジェクトにより指定されたファイルを削除する。
o equals(Object)
このオブジェクトと指定されたオブジェクトとを比較する。
o exists()
この File が存在するかをテストする。
o getAbsolutePath()
オブジェクトが表現するファイルの絶対パス名を返す。
o getCanonicalPath()
この File オブジェクトのパス名の正規の形式を返す。
o getName()
オブジェクトが表現するファイルの名前を返す。
o getParent()
名前に親の部分がない場合、この File オブジェクトの親の部分かまたは null を返す。
o getPath()
オブジェクトが表現するファイルのパス名を返す。
o hashCode()
ファイルのハッシュコードを計算する。
o isAbsolute()
File オブジェクトが表現するファイルが絶対パス名かどうかをテストする。
o isDirectory()
File オブジェクトが表現するファイルがディレクトリかどうかをテストする。
o isFile()
File オブジェクトが表現するファイルが "normal" ファイルかどうかをテストする。
o lastModified()
File オブジェクトが表現するファイルが最後に変更された時間を返す。
o length()
File オブジェクトが表現するファイルの長さを返す。
o list()
File オブジェクトが指定するディレクトリに存在するファイルのリストを返す。
o list(FilenameFilter)
File オブジェクトが指定するディレクトリに存在するファイルのリストに指定されたフィルタをかけたものを返す。
o mkdir()
File オブジェクトが指定するパス名を持つディレクトリを作成する。
o mkdirs()
File オブジェクトが指定するパス名を持つディレクトリを、必要ならば親ディレクトリを含めて、作成する。
o renameTo(File)
File オブジェクトが指定するファイルの名前を、 File 引数が指定するパス名に付け替える。
o toString()
オブジェクトの文字列表現を返す。

Variables

o separator 
 public static final String separator
システムに依存するパスセパレーター文字です。このフィールドは システムプロパティの file.separator を使って初期化されます。

参照:
getProperty
o separatorChar 
  public static final char separatorChar
システムに依存するパスセパレーター文字列です。このフィールドはシステムプロパティ file.separator の値の先頭文字を使って初期化されます。この文字はファイル名に含まれるディレクトリ成分とファイル成分を分離します。

参照:
getProperty
o pathSeparator 
  public static final String pathSeparator
システムに依存するパスセパレーター文字列です。このフィールドは システムプロパティの path.separator を使って初期化されます。

参照:
getProperty
o pathSeparatorChar 
  public static final char pathSeparatorChar
システムに依存するパスセパレーター文字です。このフィールドはシステムプロパティ path.separator の値の先頭文字を使って初期化されます。この文字はしばしば「パスリスト」として与えられる一連のファイル名を分離するために使用されます。

参照:
getProperty

Constructors

o File 
  public File(String path)
ファイルパスが引数として与えられたファイルを表現する File インスタンスを作成します。

パラメータ:
path - ファイルパス名。
例外: NullPointerException
ファイルパスが nullであった場合。
参照:
getPath
o File 
  public File(String path,
              String name)
パス名が、指定されたディレクトリパスと、セパレーター文字と、 name 引数とで与えられるファイルを表現する File インスタンスを作成します。

パラメータ:
path - ディレクトリパス名。
name - ファイルパス名。
参照:
getPath, separator
o File 
  public File(File dir,
              String name)
指定されたディレクトリ上の、指定された名前を持つファイルを表現する File インスタンスを作成します。

ディレクトリを示す引数が nullであった場合は、作成される File インスタンスは（システム依存の）カレントディレクトリ上の name引数でパスを指定されるファイルを表現します。 それ以外の場合、File インスタンスは、指定されたディレクトリパスと、セパレーター文字と、それに続く name 引数とでパス名が与えられるファイルを表現します。

パラメータ:
dir - ディレクトリ。
name - ファイルパス名。
参照:
getPath, separator

Methods

o getName 
  public String getName()
オブジェクトが表現するファイルの名前を返します。名前はパス名に最後に現れるセパレーター文字以後の全部の部分になります。

返り値:
File オブジェクトが表現するファイルの名前（ディレクトリ成分は含まない）。
参照:
getPath, separator
o getPath 
  public String getPath()
オブジェクトが表現するファイルのパス名を返します。

返り値:
この File オブジェクトが表現するパス名。
o getAbsolutePath 
  public String getAbsolutePath()
オブジェクトが表現するファイルの絶対パス名を返します。 オブジェクトが絶対パス名を表現しているならば、そのままパス名を返し、 そうでないならば、カレントユーザーディレクトリと、セパレーター文字と、ファイルオブジェクトのパス名を連接したものを返します。

システムプロパティ user.dir がカレントユーザーディレクトリを保持しています。

返り値:
File のシステムに依存する絶対パス名。
参照:
getPath, isAbsolute, getProperty
o getCanonicalPath 
  public String getCanonicalPath() throws IOException
この File オブジェクトのパス名の正規の形式を返します。正規の形式の正確な定義はシステムに依存しますが、通常これは絶対パス名を指定します。この絶対パス名において、現在のユーザディレクトリへのすべての関連参照と参照は完全に解決しません。実在しないファイルのパス名の正規の形式は定義されません。

例外: IOException
I/O エラーが発生した場合 (正規のパスはファイルシステムの問い合わせを必要とするので、発生する可能性がある)。
o getParent 
  public String getParent()
パス名に親の部分がない場合、この File オブジェクトのひとつ上の部分に戻るかまたは null を返します。この親の部分は、正確な定義はシステムに依存しますが、通常最後に記載されている"\"または"/"に到達するまでの すべてを指します。例えば、UNIX 上では "/usr/lib" の親の部分は "/usr" であり、"/usr"の親の部分は "/" であり、これは親を持ちません。Windows プラットフォーム上では、"c:\java" の親の部分は "c:\" であり、これは親を持ちません。

参照:
getPath, getCanonicalPath, separator
o exists 
  public boolean exists()
File が存在するかどうかをテストします。

返り値:
このオブジェクトが指定するファイルが存在すれば true、それ以外の場合は false。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して read access を許されているかをチェックする。
参照:
getPath, checkRead
o canWrite 
  public boolean canWrite()
アプリケーションがこのファイルに書き込み可能かをテストします。

返り値:
オブジェクトが名前を指定するファイルに対してアプリケーションが書き込みを許可されている場合は true、それ以外の場合は false。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkWriteメソッドが呼び出され、アプリケーションがこのファイルに対して書き込みアクセスを許されているかをチェックする。
参照:
getPath, checkWrite
o canRead 
  public boolean canRead()
アプリケーションが指定されたファイルからの読み込みが可能かをテストします。

返り値:
オブジェクトが指定するファイルが存在し、アプリケーションがそのファイルから読み込み可能であれば true、それ以外の場合は false。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して読み込みアクセスを許されているかをチェックする。
参照:
getPath, checkRead
o isFile 
  public boolean isFile()
File オブジェクトの表現するファイルが "normal" ファイルであるかをテストします。

ファイルはそれがディレクトリではなく、かつシステムに依存する他の条件を満たしていれば "normal" です。Java のアプリケーションが作るディレクトリ以外のファイルは全て normal であることが保証されています。

返り値:
オブジェクトが指定するファイルが存在し、かつ "normal" ファイルであれば true、それ以外の場合は false 。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して読み込みアクセスを許されているかをチェックする。
参照:
getPath, checkRead
o isDirectory 
  public boolean isDirectory()
File オブジェクトが表現するファイルがディレクトリであるかをテストします。

返り値:
File が存在し、かつそれがディレクトリであると true、それ以外の場合は false。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して読み込みアクセスを許されているかをチェックする。
参照:
getPath, checkRead
o isAbsolute 
  public native boolean isAbsolute()
File オブジェクトが表現するファイルが絶対パス名であるかをテストします。絶対パス名の定義はシステムに依存します。例えば、UNIX の場合は先頭文字がセパレーター文字であるときに絶対パス名であり、Windows プラットフォームの場合は先頭文字が ASCII '\' であるか、 '/'か、またはその後にコロンが続く文字であるときに絶対パスになります。

返り値:
File オブジェクトが指示するパス名が絶対パス名であるとき true 、それ以外の場合はfalse。
参照:
getPath, separator
o lastModified 
  public long lastModified()
File オブジェクトが表現するファイルが最後に変更された時間を返します。

返される値はシステムに依存しますから、lastModified から返された値とのみ比較が可能です。この時間を絶対時間と解釈してはいけません。

返り値:
オブジェクトが指定するファイルが最後に変更された時間。 指定されたファイルが存在しない場合は 0L。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して読み込みアクセスを許されているかをチェックする。
参照:
getPath, checkRead
o length 
  public long length()
File オブジェクトが表現するファイルの長さを返します。

返り値:
オブジェクトが指定するファイルの長さをバイト単位で返し、もし指定のファイルが存在しない場合は 0Lを返す。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して読み込みアクセスを許されているかをチェックする。
参照:
getPath, checkRead
o mkdir 
  public boolean mkdir()
File オブジェクトが指定するパス名のディレクトリを作成します。

返り値:
ディレクトリの作成に成功すると true、それ以外の場合は false 。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkWriteメソッドが呼び出され、アプリケーションがこのファイルに対して write access を許されているかをチェックする。
参照:
getPath, checkWrite
o renameTo 
  public boolean renameTo(File dest)
File オブジェクトが指定するファイルの名前を、 File 引数が指定するパス名に付け替えます。

パラメータ:
dest - 新しいファイル名。
返り値:
名前の付け替えに成功すると true、それ以外の場合は false。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名とターゲットファイルのパス名を引数として checkWriteメソッドが呼び出され、アプリケーションがこの両方のファイルに対して書き込みが許されているかをチェックする。
参照:
getPath, checkWrite
o mkdirs 
  public boolean mkdirs()
File オブジェクトが指定するパス名を持つディレクトリを、必要ならば親ディレクトリを含めて作成します。

返り値:
ディレクトリの作成に成功すると true、それ以外の場合は false 。
例外: SecurityException
セキュリティマネージャが存在すると、ディレクトリを作成する前に、作成したい各ディレクトリのパス名を引数として checkWriteメソッドが呼び出される。
参照:
getPath, checkWrite
o list 
  public String[] list()
File オブジェクトが指定するディレクトリに存在するファイルのリストを返します。

返り値:
指定されたディレクトリに存在するファイル名のリスト。 このリストにはカレントディレクトリや親ディレクトリ (UNIX システムの場合の "." と "..") は含まれない。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して読み込みアクセスを許されているかをチェックする。
参照:
getPath, checkRead
o list 
  public String[] list(FilenameFilter filter)
File オブジェクトが指定するディレクトリに存在するファイルのリストに指定されたフィルタをかけたものを返します。

パラメータ:
filter - ファイル名に対するフィルタ。
返り値:
指定されたディレクトリに存在するファイル名の配列。 このリストにはカレントディレクトリや親ディレクトリ (UNIX システムの場合の "." と "..") は含まれない。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkReadメソッドが呼び出され、アプリケーションがこのファイルに対して読み込みアクセスを許されているかをチェックする。
参照:
getPath, FilenameFilter, checkRead
o delete 
  public boolean delete()
オブジェクトにより指定されるファイルを削除します。

返り値:
ファイルの削除に成功すると true、それ以外の場合は false。
例外: SecurityException
セキュリティマネージャが存在すると、この File へのパス名を引数として checkDeleteメソッドが呼び出され、アプリケーションがこのファイルに対して削除を許されているかをチェックする。
参照:
getPath, checkDelete
o hashCode 
  public int hashCode()
ファイルのハッシュコードを計算します。

返り値:
この File オブジェクトに対するハッシュコード。
オーバーライド:
Object クラスの hashCode
o equals 
  public boolean equals(Object obj)
このオブジェクトと指定されたオブジェクトを比較します。 引数が null ではなく、かつ File オブジェクトのパス名がこのオブジェクトのパス名と同一であるときにのみ true を返します。

パラメータ:
obj - 比較するオブジェクト。
返り値:
オブジェクトが同一であるとき true、それ以外の場合は false。
オーバーライド:
Object クラスの equals
o toString 
  public String toString()
オブジェクトの文字列表現を返します。

返り値:
このオブジェクトのパス名を表す文字列。
オーバーライド:
Object クラスの toString
参照:
getPath 
全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス