Класс File

Абстрактное представление путей к файлам и каталогам.

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

1. Необязательная зависящая от системы префиксная строка, такая как указатель диска, "/" для корневого каталога UNIX, или "\\\\" для UNC-пути Microsoft Windows, и
2. Последовательность из нуля или более строковых имен.

Преобразование строки пути в абстрактный путь или обратно зависит от системы. Когда абстрактный путь преобразуется в строку пути, каждое имя отделяется от следующего одной копией символа разделителя по умолчанию. Символ разделителя имен по умолчанию определяется системной переменной file.separator, и доступен в общедоступных статических полях separator и separatorChar этого класса. При преобразовании строки пути в абстрактный путь имена в ней могут быть разделены символом разделителя имен по умолчанию или любым другим символом разделителя имен, поддерживаемым основной системой.

Путь, будь то абстрактный или в виде строки, может быть либо абсолютным, либо относительным. Абсолютный путь является полным, так как для определения файла, который он обозначает, не требуется дополнительная информация. Относительный путь, напротив, должен интерпретироваться в терминах информации, взятой из другого пути. По умолчанию классы в пакете java.io всегда разрешают относительные пути относительно текущего каталога пользователя. Этот каталог определяется системной переменной user.dir, и, как правило, это каталог, в котором была вызвана виртуальная машина Java.

Родительский элемент абстрактного пути может быть получен вызовом метода getParent() этого класса и состоит из префикса пути и каждого имени в последовательности имен пути, за исключением последнего. Абсолютный путь каждого каталога является предком любого объекта File с абсолютным абстрактным путем, который начинается с абсолютного пути каталога. Например, каталог, обозначенный абстрактным путем "/usr", является предком каталога, обозначенного путем "/usr/local/bin".

Концепция префикса используется для обработки корневых каталогов на платформах UNIX и указателей дисков, корневых каталогов и UNC-путей на платформах Microsoft Windows следующим образом:

• Для платформ UNIX префикс абсолютного пути всегда "/". Относительные пути не имеют префикса. Абстрактный путь, обозначающий корневой каталог, имеет префикс "/" и пустую последовательность имен.
• Для платформ Microsoft Windows префикс пути, содержащего указатель диска, состоит из буквы диска, за которой следует ":" и, возможно, за которым следует "\\" , если путь является абсолютным. Префикс UNC-пути "\\\\"; имя хоста и имя ресурса — это первые два имени в последовательности имен. Относительный путь, не определяющий диск, не имеет префикса.

Экземпляры этого класса могут или не могут обозначать фактический объект файловой системы, такой как файл или каталог. Если он обозначает такой объект, то этот объект находится в разделе. Раздел — это зависящая от операционной системы часть хранилища для файловой системы. Одно хранилище (например, физический диск, флэш-память, CD-ROM) может содержать несколько разделов. Объект, если таковой имеется, будет находиться в разделе наименованном некоторым предком абсолютного вида этого пути.

Файловая система может применять ограничения к определенным операциям с фактическим объектом файловой системы, таким как чтение, запись и выполнение. Эти ограничения вместе известны как права доступа. Файловая система может иметь несколько наборов прав доступа к одному объекту. Например, один набор может применяться к владельцу объекта, а другой — ко всем остальным пользователям. Права доступа к объекту могут привести к сбоям некоторых методов в этом классе.

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

Взаимодействие с пакетом java.nio.file

Пакет java.nio.file определяет интерфейсы и классы для доступа виртуальной машиной Java к файлам, атрибутам файлов и файловым системам. Этот API может использоваться для преодоления многих ограничений класса java.io.File. Метод toPath может использоваться для получения Path, который использует абстрактный путь, представленный объектом File, для поиска файла. Полученный Path может использоваться с классом Files для обеспечения более эффективного и расширенного доступа к дополнительным операциям с файлами, атрибутам файлов и исключениям ввода-вывода, которые помогают диагностировать ошибки, когда операция с файлом завершается неудачно.

Поля

separatorChar

public static final char separatorChar

Зависимый от системы символ-разделитель имён. Это поле инициализируется первым символом значения системной переменной file.separator. В системах UNIX значение этого поля равно '/'; в системах Microsoft Windows – '\\'.

См. также:

System.getProperty(java.lang.String)

separator

public static final String separator

Зависимый от системы символ-разделитель имён, представленный строкой для удобства. Эта строка содержит один символ: separatorChar.

pathSeparatorChar

public static final char pathSeparatorChar

Зависимый от системы символ-разделитель пути. Это поле инициализируется первым символом значения системной переменной path.separator. Этот символ используется для разделения имён файлов в последовательности файлов, заданной как список путей. В системах UNIX этот символ равен ':'; в системах Microsoft Windows – ';'.

См. также:

System.getProperty(java.lang.String)

pathSeparator

public static final String pathSeparator

Зависимый от системы символ-разделитель пути, представленный строкой для удобства. Эта строка содержит один символ: pathSeparatorChar.

Конструкторы

File

public File(String pathname)

Создаёт новый объект File путем преобразования заданной строки пути в абстрактный путь. Если заданная строка пуста, результатом является пустой абстрактный путь.

Параметры:

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

Исключения:

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

File

public File(String parent,
            String child)

Параметры:

parent - Строка пути родительского каталога

child - Строка пути дочернего файла/каталога

Исключения:

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

File

public File(File parent,
            String child)

Параметры:

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

child - Строка пути дочернего файла/каталога

Исключения:

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

File

public File(URI uri)

new File( f.toURI()).equals( f.getAbsoluteFile())

Параметры:

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

Исключения:

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

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

С:

1.4

См. также:

toURI(), URI

Методы

getName

public String getName()

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

Возвращает:

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

getParent

public String getParent()

Возвращает:

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

getParentFile

public File getParentFile()

Возвращает:

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

С:

1.2

getPath

public String getPath()

Преобразует этот абстрактный путь в строку пути. Результирующая строка использует default name-separator character для разделения имён в последовательности имён.

Возвращает:

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

isAbsolute

public boolean isAbsolute()

Проверяет, является ли этот абстрактный путь абсолютным. Определение абсолютного пути зависит от системы. В системах UNIX путь абсолютный, если его префикс равен "/". В системах Microsoft Windows путь абсолютный, если его префикс – спецификатор диска, за которым следует "\\", или если его префикс равен "\\\\".

Возвращает:

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

getAbsolutePath

public String getAbsolutePath()

Возвращает:

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

Исключения:

SecurityException - Если значение необходимой системной переменной недоступно.

См. также:

isAbsolute()

getAbsoluteFile

public File getAbsoluteFile()

Возвращает абсолютную форму этого абстрактного пути. Эквивалентно new File(this.getAbsolutePath()).

Возвращает:

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

Исключения:

SecurityException - Если значение необходимой системной переменной недоступно.

С:

1.2

getCanonicalPath

public String getCanonicalPath()
                        throws IOException

Возвращает:

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

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

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

SecurityException - Если не удается получить необходимое значение системной переменной или если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.io.FileDescriptor) отклоняет доступ для чтения к файлу

С:

JDK1.1

См. также:

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

getCanonicalFile

public File getCanonicalFile()
                      throws IOException

Возвращает каноническую форму этого абстрактного имени пути. Эквивалентно new File(this.getCanonicalPath()).

Возвращает:

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

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

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

SecurityException - Если не удается получить необходимое значение системной переменной или если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.io.FileDescriptor) отклоняет доступ для чтения к файлу

С:

1.2

См. также:

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

toURL

@Deprecated
public URL toURL()
                      throws MalformedURLException

Устаревший. Этот метод не автоматически экранирует символы, недопустимые в URL. Рекомендуется, чтобы новый код преобразовывал абстрактное имя пути в URL, сначала преобразовав его в URI с помощью метода toURI, а затем преобразовав URI в URL с помощью метода URI.toURL.

Преобразует это абстрактное имя пути в URL. Точная форма URL зависит от системы. Если можно определить, что файл, обозначенный этим абстрактным именем пути, является директорией, то результирующий URL будет заканчиваться косой чертой.

Возвращает:

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

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

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

С:

1.2

См. также:

toURI(), URI, URI.toURL(), URL

toURI

public URI toURI()

new File( f.toURI()).equals( f.getAbsoluteFile())

Возвращает:

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

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

SecurityException - Если не удается получить необходимое значение системной переменной.

С:

1.4

См. также:

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

canRead

public boolean canRead()

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

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу

canWrite

public boolean canWrite()

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

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) отклоняет доступ для записи к файлу

exists

public boolean exists()

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

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу или директории

isDirectory

public boolean isDirectory()

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу

isFile

public boolean isFile()

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу

isHidden

public boolean isHidden()

Проверяет, является ли файл, указанный этим абстрактным именем пути, скрытым файлом. Точное определение скрытого зависит от системы. В системах UNIX файл считается скрытым, если его имя начинается с точки ('.'). В системах Microsoft Windows файл считается скрытым, если он помечен как таковой в файловой системе.

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) отклоняет доступ для чтения к файлу

С:

1.2

lastModified

public long lastModified()

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) запрещает чтение файла

length

public long length()

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) запрещает чтение файла

createNewFile

public boolean createNewFile()
                      throws IOException

Возвращает:

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

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в файл

С:

1.2

delete

public boolean delete()

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkDelete(java.lang.String) запрещает удаление файла

deleteOnExit

public void deleteOnExit()

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkDelete(java.lang.String) запрещает удаление файла

С:

1.2

См. также:

delete()

list

public String[] list()

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(String) запрещает чтение каталога

list

public String[] list(FilenameFilter filter)

Возвращает массив строк, имена файлов и каталогов в каталоге, обозначенном этим абстрактным именем пути, удовлетворяющих заданному фильтру. Поведение этого метода такое же, как у метода list(), за исключением того, что строки в возвращаемом массиве должны удовлетворять фильтру. Если заданный filter равен null, то все имена принимаются. В противном случае имя удовлетворяет фильтру, если и только если значение true получено при вызове метода FilenameFilter.accept(File, String) фильтра по этому абстрактному имени пути и имени файла или каталога в каталоге, который он обозначает.

Параметры:

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

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(String) запрещает чтение каталога

См. также:

Files.newDirectoryStream(Path,String)

listFiles

public File[] listFiles()

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(String) запрещает чтение каталога

С:

1.2

listFiles

public File[] listFiles(FilenameFilter filter)

Возвращает массив абстрактных имён путей, обозначающих файлы и каталоги в каталоге, обозначенном этим абстрактным именем пути, удовлетворяющих заданному фильтру. Поведение этого метода такое же, как у метода listFiles(), за исключением того, что пути в возвращаемом массиве должны удовлетворять фильтру. Если заданный filter равен null, то все пути принимаются. В противном случае путь удовлетворяет фильтру, если и только если значение true получено при вызове метода FilenameFilter.accept(File, String) фильтра по этому абстрактному имени пути и имени файла или каталога в каталоге, который он обозначает.

Параметры:

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

Возвращает:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(String) запрещает чтение каталога

С:

1.2

См. также:

Files.newDirectoryStream(Path,String)

listFiles

public File[] listFiles(FileFilter filter)

Возвращает массив абстрактных имен путей, обозначающих файлы и каталоги в каталоге, обозначаемом этим абстрактным именем пути, которые удовлетворяют заданному фильтру. Поведение этого метода такое же, как у метода listFiles(), за исключением того, что имена путей в возвращаемом массиве должны удовлетворять фильтру. Если заданный filter равен null, то принимаются все имена путей. В противном случае имя пути удовлетворяет фильтру только тогда, когда значение true получается в результате вызова метода FileFilter.accept(File) фильтра на имени пути.

Параметры:

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(String) запрещает чтение каталога

С:

1.2

См. также:

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

mkdir

public boolean mkdir()

Создает каталог, названный этим абстрактным именем пути.

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) не разрешает создание указанного каталога

mkdirs

public boolean mkdirs()

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkRead(java.lang.String) не позволяет проверить существование указанного каталога и всех необходимых родительских каталогов; или если метод SecurityManager.checkWrite(java.lang.String) не позволяет создать указанный каталог и все необходимые родительские каталоги

renameTo

public boolean renameTo(File dest)

Параметры:

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в старый или новый пути

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

setLastModified

public boolean setLastModified(long time)

Параметры:

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

Возвращает:

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

Исключения:

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в указанный файл

С:

1.2

setReadOnly

public boolean setReadOnly()

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в указанный файл

С:

1.2

setWritable

public boolean setWritable(boolean writable,
                           boolean ownerOnly)

Параметры:

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

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в указанный файл

С:

1.6

setWritable

public boolean setWritable(boolean writable)

file.setWritable(arg, true)

Параметры:

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в файл

С:

1.6

setReadable

public boolean setReadable(boolean readable,
                           boolean ownerOnly)

Параметры:

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

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в файл

С:

1.6

setReadable

public boolean setReadable(boolean readable)

file.setReadable(arg, true)

Параметры:

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в файл

С:

1.6

setExecutable

public boolean setExecutable(boolean executable,
                             boolean ownerOnly)

Параметры:

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

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в файл

С тех пор:

1.6

setExecutable

public boolean setExecutable(boolean executable)

file.setExecutable(arg, true)

Параметры:

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в файл

С тех пор:

1.6

canExecute

public boolean canExecute()

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

Возвращает:

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

Исключения:

SecurityException - Если существует менеджер безопасности и его метод SecurityManager.checkExec(java.lang.String) запрещает выполнение доступа к файлу

С тех пор:

1.6

listRoots

public static File[] listRoots()

Возвращает:

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

С тех пор:

1.2

См. также:

FileStore

getTotalSpace

public long getTotalSpace()

Возвращает размер раздела, названного данным абстрактным путем.

Возвращает:

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

Исключения:

SecurityException - Если установлен менеджер безопасности, и он запрещает RuntimePermission("getFileSystemAttributes") или его метод SecurityManager.checkRead(String) запрещает чтение файла, указанного этим абстрактным путем

С тех пор:

1.6

getFreeSpace

public long getFreeSpace()

Возвращает:

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

Исключения:

SecurityException - Если установлен менеджер безопасности, и он запрещает RuntimePermission("getFileSystemAttributes") или его метод SecurityManager.checkRead(String) запрещает чтение файла, указанного этим абстрактным путем

С тех пор:

1.6

getUsableSpace

public long getUsableSpace()

Возвращает:

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

Исключения:

SecurityException - Если установлен менеджер безопасности, и он запрещает RuntimePermission("getFileSystemAttributes") или его метод SecurityManager.checkRead(String) запрещает чтение файла, указанного этим абстрактным путем

С тех пор:

1.6

createTempFile

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

Параметры:

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

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

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

Возвращает:

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

Исключение:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) не позволяет создать файл

С:

1.2

createTempFile

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

Параметры:

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

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

Возвращает:

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

Исключение:

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

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

SecurityException - Если существует менеджер безопасности, и его метод SecurityManager.checkWrite(java.lang.String) не позволяет создать файл

С:

1.2

См. также:

Files.createTempDirectory(String,FileAttribute[])

compareTo

public int compareTo(File pathname)

Сравнивает два абстрактных имени пути лексикографически. Порядок, определённый этим методом, зависит от базовой системы. В системах UNIX регистр символов имеет значение при сравнении имён путей; в системах Microsoft Windows – нет.

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

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

Параметры:

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

Возвращает:

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

С:

1.2

equals

public boolean equals(Object obj)

Проверяет это абстрактное имя пути на равенство с данным объектом. Возвращает true, если и только если аргумент не null и является абстрактным именем пути, обозначающим тот же файл или каталог, что и это абстрактное имя пути. Равенство двух абстрактных имён путей зависит от базовой системы. В системах UNIX регистр символов имеет значение при сравнении имён путей; в системах Microsoft Windows – нет.

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

equals в классе Object

Параметры:

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

Возвращает:

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

См. также:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Вычисляет хэш-код для этого абстрактного имени пути. Так как равенство абстрактных имён путей по своей природе зависит от системы, то и вычисление их хэш-кодов зависит от системы. В системах UNIX хэш-код абстрактного имени пути равен исключающему ИЛИ хэш-кода его строки имени пути и десятичного значения 1234321. В системах Microsoft Windows хэш-код равен исключающему ИЛИ хэш-кода его строки имени пути, преобразованной в нижний регистр, и десятичного значения 1234321. Регион не учитывается при преобразовании строки имени пути в нижний регистр.

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

hashCode в классе Object

Возвращает:

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

См. также:

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

toString

public String toString()

Возвращает строку имени пути этого абстрактного имени пути. Это просто строка, возвращаемая методом getPath().

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

toString в классе Object

Возвращает:

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

toPath

public Path toPath()

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

Возвращает:

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

Исключение:

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

С:

1.7

См. также:

Path.toFile()