Спецификация языка Java Пакет java.io


Содержание | Предыдущий | Следующий | Индекс

22.24 Класс java.io.File

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

public class File {
	public static final String separator =
		System.getProperty("file.separator");
	public static final char separatorChar =
		separator.charAt(0);
	public static final String pathSeparator =
		System.getProperty("path.separator");
	public static final char pathSeparatorChar =
		pathSeparator.charAt(0);
	public File(String path) throws NullPointerException;
	public File(String dirname, String name)
		throws NullPointerException
	public File(File dir, String name)
		throws NullPointerException
	public String toString();
	public boolean equals(Object obj);
	public int hashCode();
	public String getName();
	public String getPath();
	public String getAbsolutePath();
	public String getParent();
	public native boolean isAbsolute();
	public boolean exists() throws SecurityException;
	public boolean canRead() throws SecurityException;
	public boolean canWrite() throws SecurityException;
	public boolean isFile() throws SecurityException;
	public boolean isDirectory() throws SecurityException;
	public long lastModified() throws SecurityException;
	public long length() throws SecurityException;
	public boolean mkdir() throws SecurityException;
	public boolean mkdirs() throws SecurityException;
	public String[] list() throws SecurityException;
	public String[] list(FilenameFilter filter)
		throws SecurityException;
	public boolean renameTo(File dest) throws SecurityException;
	public boolean delete() throws SecurityException;
}

22.24.1 public static final String separator = System.getProperty("file.separator");

Эта строка должна состоять из единственного символа, значение которого также доступно в поле separatorChar; строка обеспечивается просто для удобства.

22.24.2 public static final char separatorChar = separator.charAt(0);

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

22.24.3 public static final String pathSeparator = System.getProperty("path.separator");

Эта строка должна состоять из единственного символа, значение которого также доступно в поле pathSeparatorChar; строка обеспечивается просто для удобства.

22.24.4 public static final char pathSeparatorChar = pathSeparator.charAt(0);

Первое возникновение этого символа в строке, как иногда предполагается, разделяет имя хоста от пути. На системах UNIX этот символ обычно ':'.

22.24.5 public File(String path) throws NullPointerException

Этот конструктор инициализирует недавно создаваемый File так, чтобы это представило путь, обозначенный параметром path.

Если path null, a NullPointerException бросается.

22.24.6 public File(String dirname, String name)
throws NullPointerException

Этот конструктор инициализирует недавно создаваемый File так, чтобы это представило путь, часть каталога которого определяется параметром dirname и чья часть имени файла определяется параметром name. Если dirname параметр null, name используется в качестве пути; иначе связь dirname, separatorChar (§22.24.2), и name используется в качестве пути.

Если name null, a NullPointerException бросается.

22.24.7 public File(File dir, String name)
throws NullPointerException

Этот конструктор инициализирует недавно создаваемый File так, чтобы это представило путь, часть каталога которого определяется File объект dir и чья часть имени файла определяется параметром name.

Если name null, a NullPointerException бросается.

22.24.8 public String toString()

Результатом является a String равный пути представляется этим File объект.

Переопределения toString метод Object (§20.1.2).

22.24.9 public boolean equals(Object obj)

Результат true если и только если параметр не null и a File объект, который представляет тот же самый путь как это File объект. Другими словами, два File объекты равны если и только если строки, возвращенные getPath метод (§22.24.12) равен.

Переопределения equals метод Object (§20.1.3).

22.24.10 public int hashCode()

Хэш-код этого File объект равен монопольному ИЛИ хэш-кода его строки пути и десятичного значения 1234321:

this.getPath().hashcode() ^ 1234321
Переопределения hashCode метод Object (§20.1.4).

22.24.11 public String getName()

Если строка пути содержит separatorChar символ (§22.24.2), этот метод возвращает подстроку пути, который следует за последним вхождением символа разделителя; иначе, вся строка пути возвращается.

22.24.12 public String getPath()

Результатом является a String равный пути представляется этим File объект.

22.24.13 public String getAbsolutePath()

Результатом является a String равный результату преобразования в "абсолютную форму" путь представляется этим File объект.

22.24.14 public String getParent()

Если у пути есть родительский каталог, a String представление пути того родительского каталога возвращается; иначе, null возвращается.

22.24.15 public boolean isAbsolute()

Результат true если и только если путь, представленный объектом Файла, находится в абсолютной форме, указывая на полное имя, которое запускается с корня иерархии каталогов, а не имени относительно некоторого подразумеваемого каталога.

22.24.16 public boolean exists() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Результат true если и только если файловая система фактически содержит файл, который определяется путем File объект.

22.24.17 public boolean canRead() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Результат true если и только если оба из следующего являются истиной:

22.24.18 public boolean canWrite() throws SecurityException

Во-первых, если есть менеджер безопасности, checkWrite метод (§20.17.21) вызывают с путем, представленным этим File возразите как его параметр.

Результат true если и только если оба из следующего являются истиной:

22.24.19 public boolean isFile() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Результат true если и только если оба из следующего являются истиной:

22.24.20 public boolean isDirectory() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Результат true если и только если оба из следующего являются истиной:

22.24.21 public long lastModified() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Возвращается абстрактное время изменения. Если два значения, возвращенные этим методом, сравниваются, представляет ли для того же самого файла или для двух различных файлов, меньшее значение более раннее время изменения. Абстрактное время изменения не обязательно имеет любое отношение, даже монотонность, ко временам, возвращенным методом System.currentTimeMillis (§20.18.6).

22.24.22 public long length() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Длина файла, измеренного в байтах, возвращается.

22.24.23 public boolean mkdir() throws SecurityException

Во-первых, если есть менеджер безопасности, checkWrite метод (§20.17.21) вызывают с путем, представленным этим File возразите как его параметр.

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

22.24.24 public boolean mkdirs() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Если имя каталога представляется этим File у объекта есть имя родительского каталога (§22.24.14), попытка сначала предпринимается, чтобы создать родительский каталог; если эта попытка перестала работать, результат false. Иначе, как только родительский каталог был решен существовать, или если у пути нет никакого родителя, попытка предпринимается, чтобы создать каталог, определенный этим File объект. Результат true если и только если работа создания успешно выполняется.

22.24.25 public String[] list() throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Если путь представляется этим File объект не соответствует каталогу в файловой системе, тогда null возвращается. Иначе, массив строк возвращается, один для каждого файла в каталоге (на системах UNIX, имена"."и".."не включаются). Каждая строка является именем файла, не полным путем. Нет никакой гарантии, что строки появятся в любом определенном порядке в пределах массива; например, они, как гарантируют, не появятся в алфавитном порядке.

22.24.26 public String[] list(FilenameFilter filter)
throws SecurityException

Во-первых, если есть менеджер безопасности, checkRead метод (§20.17.19) вызывают с путем, представленным этим File возразите как его параметр.

Если путь представляется этим File объект не соответствует каталогу в файловой системе, тогда null возвращается. Иначе, массив строк возвращается, один для каждого файла в каталоге (на системах UNIX, имена"."и".."не включаются), чье имя удовлетворяет данный filter. Каждая строка является именем файла, не полным путем. Нет никакой гарантии, что строки появятся в любом определенном порядке в пределах массива; например, они, как гарантируют, не появятся в алфавитном порядке. Имя файла удовлетворяет фильтр если и только если значение true результаты, когда accept метод (§22.25.1) фильтра вызывают с этим File возразите и имя как параметры.

22.24.27 public boolean renameTo(File dest)
throws SecurityException

Во-первых, если есть менеджер безопасности, checkWrite метод (§20.17.21) вызывают дважды, сначала с путем, представленным этим File возразите как его параметр и снова с путем dest как его параметр.

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

22.24.28 public boolean delete() throws SecurityException

Во-первых, если есть менеджер безопасности, checkDelete метод (§20.17.22) вызывают с путем, представленным этим File возразите как его параметр.

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

22.25 Интерфейс java.io.FilenameFilter

list метод (§22.24.26) класса File требует, как параметр, объект, который реализует FilenameFilter интерфейс. Единственная цель такого объекта состоит в том, чтобы обеспечить метод accept это решает, какие файлы должны появиться в сгенерированном перечислении каталога.

public interface FilenameFilter {
	public boolean accept(File dir, String name);
}

22.25.1 public boolean accept(File dir, String name)

Этот метод должен возвратиться true если и только если данный файл называют name в каталоге dir должен появиться в заключительном списке файлов, сгенерированных list метод (§22.24.26) класса File.


Содержание | Предыдущий | Следующий | Индекс

Спецификация языка Java (HTML, сгенерированный Блинчиком "сюзет" Pelouch 24 февраля 1998)
Авторское право © Sun Microsystems, Inc 1996 года. Все права защищены
Пожалуйста, отправьте любые комментарии или исправления к doug.kramer@sun.com



Spec-Zone.ru - all specs in one place



free hit counter