Класс File

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(LinkOption...)

public File getCanonicalFile() throws IOException

Возвращает:

Строку канонического пути, указывающую на тот же файл или каталог, что и этот абстрактный путь

Выбрасывает:

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

Начиная с версии:

1.2

См. также:

• Path.toRealPath(LinkOption...)

@Deprecated public URL toURL() throws MalformedURLException

Возвращает:

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

Выбрасывает:

MalformedURLException — если путь не удаётся разобрать как URL

Начиная с версии:

1.2

См. также:

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

public URI toURI()

Возвращает:

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

Начиная с версии:

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:

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

Если необходимо отличить исключение ввода-вывода от случая, когда возвращается 0L, одновременно получить несколько атрибутов одного файла или получить время последнего доступа либо время создания, можно использовать метод Files.readAttributes. Если же требуется только время последнего изменения, вместо него можно использовать метод Files.getLastModifiedTime.

Возвращает:

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

public long length()

Возвращает:

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

public boolean createNewFile() throws IOException

Возвращает:

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

Выбрасывает:

IOException — если произошла ошибка ввода-вывода

Начиная с версии:

1.2

public boolean delete()

Возвращает:

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

public void deleteOnExit()

Начиная с версии:

1.2

См. также:

• delete()

public String[] list()

Возвращает:

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

public String[] list(FilenameFilter filter)

Параметры:

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

Возвращает:

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

См. также:

• 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()

Возвращает:

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

С версии:

1.6

См. также:

• FileStore.getUnallocatedSpace()

public long getUsableSpace()

Возвращает:

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

С версии:

1.6

См. также:

• FileStore.getUsableSpace()

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

Параметры:

prefix — строка префикса для формирования имени файла; должна содержать не менее трёх символов

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

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

Возвращает:

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

Выбрасывает:

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

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

С версии:

1.2

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

Параметры:

prefix — строка префикса, используемая при формировании имени файла; должна содержать не менее трех символов

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

Возвращает:

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

Вызывает исключение:

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

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

Начиная с версии:

1.2

См. также:

• Files.createTempDirectory(String,FileAttribute[])

public int compareTo(File pathname)

Определено в:

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

Параметры:

pathname — абстрактное имя пути, сравниваемое с этим абстрактным именем пути

Возвращает:

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

Начиная с версии:

1.2

public boolean equals(Object obj)

Переопределяет:

equals в классе Object

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

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

Параметры:

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

Возвращает:

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

См. также:

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

public int hashCode()

Переопределяет:

hashCode в классе Object

Возвращает:

Хеш-код этого абстрактного имени пути

См. также:

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

public String toString()

Переопределяет:

toString в классе Object

Возвращает:

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

public Path toPath()

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

Возвращает:

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

Вызывает исключение:

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

Начиная с версии:

1.7

См. также:

• Path.toFile()