Файл класса

public static final char separatorChar

См. также:

• System.getProperty(java.lang.String)

public static final String separator

public static final char pathSeparatorChar

См. также:

• System.getProperty(java.lang.String)

public static final String pathSeparator

public File(String pathname)

Параметры:

pathname - Строка пути

Исключения:

NullPointerException - Если аргумент pathname является null

public File(String parent, String child)

Параметры:

parent - Строка пути к родителю

child - Строка пути к дочернему элементу

Исключения:

NullPointerException - Если child является null

public File(File parent, String child)

Параметры:

parent - Родительский абстрактный путь

child - Строка пути к дочернему элементу

Исключения:

NullPointerException - Если child является null

public File(URI uri)

Параметры:

uri - Абсолютный иерархический URI со схемой, равной "file", ненулевым компонентом пути и неопределёнными компонентами авторизации, запроса и фрагмента

Исключения:

NullPointerException - Если uri является null

IllegalArgumentException - Если условия на параметр не соблюдаются

С:

1.4

См. также:

• toURI()
• URI

public String getName()

Возвращает:

Имя файла или каталога, обозначаемого этим абстрактным путём, или пустая строка, если последовательность имён этого пути пуста

public String getParent()

Возвращает:

Строка пути к родительской директории, обозначаемой этим абстрактным путём, или null, если этот путь не указывает на родительскую директорию

public File getParentFile()

Возвращает:

Абстрактный путь к родительской директории, обозначаемой этим абстрактным путём, или null, если этот путь не указывает на родительскую директорию

С:

1.2

public String getPath()

Возвращает:

Строковая форма этого абстрактного пути

public boolean isAbsolute()

Возвращает:

true, если этот абстрактный путь является абсолютным, false в противном случае

public String getAbsolutePath()

Возвращает:

Абсолютная строка пути, обозначающая тот же файл или каталог, что и это абстрактное имя пути

См. также:

• isAbsolute()

public File getAbsoluteFile()

Возвращает:

Абстрактное имя абсолютного пути, обозначающее тот же файл или каталог, что и это абстрактное имя пути

С:

1.2

public String getCanonicalPath() throws IOException

Возвращает:

Каноническая строка пути, обозначающая тот же файл или каталог, что и это абстрактное имя пути

Исключения:

IOException - Если возникает ошибка ввода-вывода, что возможно, поскольку построение канонического пути может потребовать запросов к файловой системе

С:

1.1

См. также:

• Path.toRealPath(java.nio.file.LinkOption...)

public File getCanonicalFile() throws IOException

Возвращает:

Каноническая строка пути, обозначающая тот же файл или каталог, что и это абстрактное имя пути

Исключения:

IOException - Если возникает ошибка ввода-вывода, что возможно, поскольку построение канонического пути может потребовать запросов к файловой системе

С:

1.2

См. также:

• Path.toRealPath(java.nio.file.LinkOption...)

@Deprecated public URL toURL() throws MalformedURLException

Возвращает:

Объект URL, представляющий эквивалентный URL файла

Исключения:

MalformedURLException - Если путь не может быть проанализирован как URL

С:

1.2

См. также:

• toURI()
• URI
• URI.toURL()
• URL

public URI toURI()

Возвращает:

Абсолютный иерархический URI со схемой, равной "file", путём, представляющим это абстрактное имя пути, и неопределёнными компонентами authority, query и fragment

С:

1.4

См. также:

• File(java.net.URI)
• URI
• URI.toURL()

public boolean canRead()

Возвращает:

true если и только если файл, указанный этим абстрактным именем пути, существует и может быть прочитан приложением; false в противном случае

public boolean canWrite()

Возвращает:

true если и только если файловая система фактически содержит файл, обозначенный этим абстрактным именем пути, и приложение разрешено писать в файл; false в противном случае.

public boolean exists()

Возвращает:

true если и только если файл или каталог, обозначаемый этим абстрактным именем пути, существует; false в противном случае

public boolean isDirectory()

Возвращает:

true если и только если файл, обозначаемый этим абстрактным именем пути, существует и является каталогом; false в противном случае

public boolean isFile()

Возвращает:

true тогда и только тогда, когда файл, обозначенный этим абстрактным именем пути, существует и является обычным файлом; false в противном случае

public boolean isHidden()

Примечание по реализации:

Если файл является символической ссылкой, то в системе UNIX он считается скрытым, если имя самой ссылки, а не её целевого объекта, начинается с символа точки. В системах Windows символическая ссылка считается скрытой, если её целевой объект помечен как таковой в файловой системе.

Возвращает:

true тогда и только тогда, когда файл, обозначенный этим абстрактным именем пути, является скрытым в соответствии с соглашениями используемой платформы

С:

1.2

public long lastModified()

Примечание API:

Хотя единицей времени возвращаемого значения является миллисекунда, точность значения зависит от файловой системы и может быть больше. Например, некоторые файловые системы используют метки времени в единицах секунд.

В тех случаях, когда необходимо отличить исключение I/O от случая, когда 0L возвращается, или когда требуются несколько атрибутов одного и того же файла, или когда требуется время последнего доступа или время создания, можно использовать метод Files.readAttributes. Однако, если требуется только время последнего изменения, можно вместо этого использовать метод Files.getLastModifiedTime.

Возвращает:

Значение типа long, представляющее время последнего изменения файла, измеряемое в миллисекундах с момента эпохи (00:00:00 GMT, 1 января 1970 г.), или 0L, если файла не существует или произошла ошибка I/O. Значение может быть отрицательным, обозначая количество миллисекунд до эпохи

public long length()

Возвращает:

Длину файла, обозначенного этим абстрактным именем пути, в байтах, или 0L, если файла не существует. Некоторые операционные системы могут возвращать 0L для имён путей, обозначающих зависящие от системы сущности, такие как устройства или каналы.

public boolean createNewFile() throws IOException

Возвращает:

true, если указанный файл не существует и был успешно создан; false, если указанный файл уже существует

Исключение:

IOException — Если произошла ошибка I/O

С:

1.2

public boolean delete()

Возвращает:

true, если и только если файл или каталог успешно удалены; false в противном случае

public void deleteOnExit()

С:

1.2

См. также:

• delete()

public String[] list()

Возвращает:

Массив строк, имена файлов и каталогов в каталоге, обозначенном этим абстрактным именем пути. Массив будет пустым, если каталог пуст. Возвращает null, если это абстрактное имя пути не обозначает каталог или если произошла ошибка I/O.

public String[] list(FilenameFilter filter)

Параметры:

filter — Фильтр имён файлов

Возвращает:

Массив строк, имена файлов и каталогов в каталоге, обозначенном этим абстрактным именем пути, которые были приняты заданным filter. Массив будет пустым, если каталог пуст или если ни одно имя не было принято фильтром. Возвращает null, если это абстрактное имя пути не обозначает каталог, или если произошла ошибка I/O.

См. также:

• Files.newDirectoryStream(Path,String)

public File[] listFiles()

Возвращает:

Массив абстрактных путей, обозначающих файлы и каталоги в каталоге, обозначенном этим абстрактным именем пути. Массив будет пустым, если каталог пуст. Возвращает null, если этот абстрактный путь не обозначает каталог или если произошла ошибка ввода-вывода.

С:

1.2

public File[] listFiles(FilenameFilter filter)

Параметры:

filter - Фильтр имён файлов

Возвращает:

Массив абстрактных путей, обозначающих файлы и каталоги в каталоге, обозначенном этим абстрактным именем пути. Массив будет пустым, если каталог пуст. Возвращает null, если этот абстрактный путь не обозначает каталог или если произошла ошибка ввода-вывода.

С:

1.2

См. также:

• Files.newDirectoryStream(Path,String)

public File[] listFiles(FileFilter filter)

Параметры:

filter - Фильтр файлов

Возвращает:

Массив абстрактных путей, обозначающих файлы и каталоги в каталоге, обозначенном этим абстрактным именем пути. Массив будет пустым, если каталог пуст. Возвращает null, если этот абстрактный путь не обозначает каталог или если произошла ошибка ввода-вывода.

С:

1.2

См. также:

• Files.newDirectoryStream(Path,java.nio.file.DirectoryStream.Filter)

public boolean mkdir()

Возвращает:

true тогда и только тогда, когда каталог был создан; false в противном случае

public boolean mkdirs()

Возвращает:

true тогда и только тогда, когда каталог был создан, вместе со всеми необходимыми родительскими каталогами; false в противном случае

public boolean renameTo(File dest)

Параметры:

dest - Новый абстрактный путь для указанного файла

Возвращает:

true тогда и только тогда, когда переименование прошло успешно; false в противном случае

Исключения:

NullPointerException - Если параметр dest является null

public boolean setLastModified(long time)

Параметры:

time - Новое время последнего изменения, измеренное в миллисекундах с начала эпохи (00:00:00 GMT, 1 января 1970 г.)

Возвращает:

true тогда и только тогда, когда операция выполнена успешно; false в противном случае

Исключения:

IllegalArgumentException - Если аргумент отрицательный

С:

1.2

public boolean setReadOnly()

Возвращает:

true тогда и только тогда, когда операция выполнена успешно; false в противном случае

С:

1.2

public boolean setWritable(boolean writable, boolean ownerOnly)

Параметры:

writable - Если true, устанавливает разрешение доступа, позволяющее операции записи; если false, чтобы запретить операции записи

ownerOnly - Если true, разрешение на запись применяется только к разрешению на запись владельца; в противном случае, оно применяется ко всем пользователям. Если базовой файловой системе нельзя различить разрешение на запись владельца от разрешения на запись других пользователей, то разрешение будет применяться ко всем пользователям, независимо от этого значения.

Возвращает:

true тогда и только тогда, когда операция выполнена успешно. Операция завершится неудачей, если у пользователя нет разрешения на изменение разрешений доступа к этому абстрактному имени пути.

С:

1.6

public boolean setWritable(boolean writable)

    file.setWritable(arg, true)

Параметры:

writable - Если true, устанавливает разрешение доступа для разрешения операций записи; если false, чтобы запретить операции записи

Возвращает:

true только в том случае, если операция прошла успешно. Операция завершится неудачно, если у пользователя нет разрешения на изменение разрешений доступа для этого абстрактного имени пути.

С:

1.6

public boolean setReadable(boolean readable, boolean ownerOnly)

Параметры:

readable - Если true, устанавливает разрешение доступа для разрешения операций чтения; если false, чтобы запретить операции чтения

ownerOnly - Если true, разрешение на чтение применяется только к разрешению на чтение владельца; в противном случае оно применяется ко всем. Если подлежащая файловая система не может различать разрешение на чтение владельца от разрешения на чтение других пользователей, то разрешение будет применяться ко всем, независимо от этого значения.

Возвращает:

true, если операция прошла успешно, false, если она завершилась неудачей, или значение параметра readable, если установка разрешения на чтение не поддерживается.

С:

1.6

public boolean setReadable(boolean readable)

    file.setReadable(arg, true)

Параметры:

readable - Если true, устанавливает разрешение доступа для разрешения операций чтения; если false, чтобы запретить операции чтения

Возвращает:

true, если операция прошла успешно, false, если она завершилась неудачей, или значение параметра readable, если установка разрешения на чтение не поддерживается.

С:

1.6

public boolean setExecutable(boolean executable, boolean ownerOnly)

Параметры:

executable - Если true, устанавливает разрешение доступа для разрешения операций выполнения; если false, чтобы запретить операции выполнения

ownerOnly - Если true, разрешение на выполнение применяется только к разрешению на выполнение владельца; в противном случае оно применяется ко всем. Если подлежащая файловая система не может различать разрешение на выполнение владельца от разрешения на выполнение других пользователей, то разрешение будет применяться ко всем, независимо от этого значения.

Возвращает:

true, если операция прошла успешно, false, если она завершилась неудачей, или значение параметра executable, если установка разрешения на выполнение не поддерживается.

С:

1.6

public boolean setExecutable(boolean executable)

    file.setExecutable(arg, true)

Параметры:

executable - Если true, устанавливает разрешение доступа для разрешения операций выполнения; если false, чтобы запретить операции выполнения

Возвращает:

true, если операция прошла успешно, false, если она завершилась неудачей, или значение параметра executable, если установка разрешения на выполнение не поддерживается.

С:

1.6

public boolean canExecute()

Возвращает:

true, если и только если абстрактное имя пути существует и приложению разрешено выполнять файл

С:

1.6

public static File[] listRoots()

Примечание по реализации:

Платформы Windows, например, имеют корневой каталог для каждого активного диска; платформы UNIX имеют один корневой каталог, а именно "/". Набор корней файловой системы зависит от различных операций на уровне системы, таких как отключение или размонтирование физических или виртуальных дисков.

Каноническое имя пути файла, находящегося на другом компьютере и доступного через протокол удаленной файловой системы, такой как SMB или NFS, может или не может начинаться с одного из корней, возвращаемых этим методом. Если имя пути удаленного файла синтаксически неотличимо от имени пути локального файла, то оно будет начинаться с одного из корней, возвращаемых этим методом. Таким образом, например, объекты File, обозначающие корневые каталоги сопоставленных сетевых дисков платформы Windows, будут возвращаться этим методом, в то время как объекты File, содержащие имена пути UNC, не будут возвращаться этим методом.

Возвращает:

Массив объектов File, обозначающих доступные корни файловой системы, или null, если набор корней определить невозможно. Массив будет пустым, если корней файловой системы нет.

С:

1.2

См. также:

• FileStore

public long getTotalSpace()

Возвращает:

Размер в байтах раздела или 0L, если это абстрактное имя пути не является именем раздела или размер получить невозможно

С:

1.6

См. также:

• FileStore.getTotalSpace()

public long getFreeSpace()

Returns:

Количество нераспределенных байтов в разделе или 0L, если абстрактное имя пути не указывает на раздел или если это число невозможно получить. Это значение будет меньше или равно общему размеру файловой системы, возвращаемому getTotalSpace().

Since:

1.6

See Also:

• FileStore.getUnallocatedSpace()

public long getUsableSpace()

Returns:

Количество доступных байтов в разделе или 0L, если абстрактное имя пути не указывает на раздел или если это число невозможно получить. На системах, где эта информация недоступна, этот метод будет эквивалентен вызову getFreeSpace().

Since:

1.6

See Also:

• FileStore.getUsableSpace()

public static File createTempFile(String prefix, String suffix, File directory) throws IOException

Parameters:

prefix - Строка префикса, используемая для генерации имени файла; должна быть длиной не менее трех символов

suffix - Строка суффикса, используемая для генерации имени файла; может быть null, в этом случае используется суффикс ".tmp"

directory - Каталог, в котором должен быть создан файл, или null, если должен использоваться временный каталог по умолчанию

Returns:

Абстрактное имя пути, обозначающее вновь созданный пустой файл

Throws:

IllegalArgumentException - Если аргумент prefix содержит менее трех символов

IOException - Если файл не удалось создать

Since:

1.2

public static File createTempFile(String prefix, String suffix) throws IOException

Parameters:

prefix - Строка префикса, используемая для генерации имени файла; должна быть длиной не менее трех символов

suffix - Строка суффикса, используемая для генерации имени файла; может быть null, в этом случае используется суффикс ".tmp"

Returns:

Абстрактное имя пути, обозначающее вновь созданный пустой файл

Throws:

IllegalArgumentException - Если аргумент prefix содержит менее трех символов

IOException - Если файл не удалось создать

Since:

1.2

See Also:

• Files.createTempDirectory(String,FileAttribute[])

public int compareTo(File pathname)

Specified by:

compareTo в интерфейсе Comparable<File>

Parameters:

pathname - Абстрактное имя пути, которое нужно сравнить с этим абстрактным именем пути

Returns:

Ноль, если аргумент равен этому абстрактному имени пути, значение меньше нуля, если это абстрактное имя пути лексикографически меньше аргумента, или значение больше нуля, если это абстрактное имя пути лексикографически больше аргумента

Since:

1.2

public boolean equals(Object obj)

Overrides:

equals в классе Object

API Note:

Этот метод только проверяет, равны ли абстрактные имена путей; он не обращается к файловой системе, и файл не обязательно должен существовать.

Parameters:

obj - Объект, который нужно сравнить с этим абстрактным именем пути

Returns:

true, если и только если объекты совпадают; false в противном случае

See Also:

• compareTo(File)
• Files.isSameFile(Path,Path)

public int hashCode()

Overrides:

hashCode in class Object

Returns:

Код хэша для этого абстрактного имени пути

See Also:

• Object.equals(java.lang.Object)
• System.identityHashCode(java.lang.Object)

public String toString()

Overrides:

toString in class Object

Returns:

Строковая форма этого абстрактного имени пути

public Path toPath()

        FileSystems.getDefault().getPath(this.getPath());

Returns:

Path, созданный из этого абстрактного пути

Throws:

InvalidPathException - если объект Path не может быть создан из абстрактного пути (см. FileSystem.getPath)

Since:

1.7

See Also:

• Path.toFile()