Класс 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

Параметры:

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