Интерфейс Path

FileSystem getFileSystem()

boolean isAbsolute()

Указывает, является ли этот путь абсолютным.

Абсолютный путь завершён и не требует объединения с другими сведениями о пути для поиска файла.

Path getRoot()

Path getFileName()

Path getParent()

Возвращает родительский путь или null если у этого пути нет родителя.

Родитель этого объекта пути состоит из корневого компонента этого пути, если он есть, и каждого элемента в пути, кроме наидальнейшего от корня в иерархии каталогов. Этот метод не обращается к файловой системе; путь или его родитель могут не существовать. Кроме того, этот метод не удаляет специальные имена, такие как "." и "..", которые могут использоваться в некоторых реализациях. Например, на UNIX родитель "/a/b/c" — "/a/b", а родитель ""x/y/." — "x/y". Этот метод может использоваться с методом normalize для устранения избыточных имён в случаях, когда требуется навигация, похожая на оболочку.

Если у этого пути есть один или несколько элементов и нет корневого компонента, то этот метод эквивалентен вычислению выражения:

subpath(0, getNameCount()-1);

int getNameCount()

Path getName(int index)

Возвращает элемент имени этого пути как объект Path.

Параметр index — индекс возвращаемого элемента имени. Элемент, наиболее близкий к корню в иерархии каталогов, имеет индекс 0. Элемент, наидальнейший от корня, имеет индекс count-1.

Path subpath(int beginIndex,
             int endIndex)

Возвращает относительный Path в виде подпоследовательности элементов имени этого пути.

Параметры beginIndex и endIndex определяют подпоследовательность элементов имени. Элемент, наиболее близкий к корню в иерархии каталогов, имеет индекс 0. Элемент, наидальнейший от корня, имеет индекс count-1. Возвращаемый объект Path содержит элементы имени, которые начинаются с beginIndex и заканчиваются элементом с индексом endIndex-1.

boolean startsWith(Path other)

Проверяет, начинается ли этот путь с указанного пути.

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

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

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

boolean startsWith(String other)

boolean endsWith(Path other)

Проверяет, заканчивается ли этот путь заданным путём.

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

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

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

boolean endsWith(String other)

Path normalize()

Возвращает путь, в котором устранены дублирующиеся элементы имени.

Точное определение этого метода зависит от реализации, но в общем случае он выводится из этого пути, пути, не содержащего избыточных элементов имени. Во многих файловых системах «.» и «..» — это специальные имена, используемые для указания текущей директории и родительской директории. В таких файловых системах все вхождения «.» считаются избыточными. Если «..» предшествует имени, которое не является «..», оба имени считаются избыточными (процесс идентификации таких имён повторяется до тех пор, пока он больше не применим).

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

Path resolve(Path other)

Резолвирует указанный путь по отношению к этому пути.

Если параметр other является absolute путём, то этот метод тривиально возвращает other. Если other является пустым путём, то этот метод тривиально возвращает этот путь. В противном случае этот метод рассматривает этот путь как каталог и резолвирует указанный путь относительно этого пути. В простейшем случае заданный путь не имеет компонента root, в этом случае этот метод объединяет заданный путь с этим путём и возвращает результирующий путь, который ends заданным путём. В случае, когда у заданного пути есть корневой компонент, резолюция сильно зависит от реализации и поэтому не определена.

Path resolve(String other)

Path resolveSibling(Path other)

Path resolveSibling(String other)

Path relativize(Path other)

Строит относительный путь между этим путём и заданным путём.

Относительное преобразование - обратное преобразованию resolution. Этот метод пытается построить relative путь, который, при resolved относительно этого пути, даёт путь, указывающий на тот же файл, что и заданный путь. Например, в UNIX, если этот путь "/a/b" а заданный путь "/a/b/c/d" , то результирующий относительный путь будет "c/d". Если у этого пути и заданного пути нет компоненты корня, то может быть построен относительный путь. Относительный путь не может быть построен, если у одного из путей есть компонент корня. Если у обоих путей есть компонент корня, то построение относительного пути зависит от реализации. Если этот путь и заданный путь equal, то возвращается пустой путь.

Для любых двух normalized путей p и q, где q не имеет компоненты корня,

p.relativize(p.resolve(q)).equals(q)

Когда поддерживаются символические ссылки, то вопрос о том, получит ли результирующий путь, при разрешении относительно этого пути, путь, который может быть использован для поиска same файла как и other зависит от реализации. Например, если этот путь "/a/b" а заданный путь "/a/x" , то результирующий относительный путь может быть "../x". Если "b" это символическая ссылка, то вопрос о том, получит ли "a/b/../x" путь, который указывает на тот же файл, что и "/a/x", зависит от реализации.

URI toUri()

Возвращает URI для представления этого пути.

Этот метод строит абсолютный URI с scheme, равным схеме URI, которая идентифицирует провайдер. Точная форма части, специфичной для схемы, сильно зависит от провайдера.

В случае стандартного провайдера, URI иерархический, с path компонентом, который абсолютный. Компоненты запроса и фрагмента не определены. Определение компонента авторитета зависит от реализации. Нет гарантии, что URI можно использовать для построения java.io.File. В частности, если этот путь представляет собой UNC-путь, то имя сервера UNC может быть закодировано в компоненте авторитета результирующего URI. В случае стандартного провайдера, если файл существует, и можно определить, что это каталог, то результирующий URI будет заканчиваться слэшем.

Стандартный провайдер предоставляет аналогичную гарантию обратного преобразования классу File. Для данного Path p гарантируется, что

Paths.get(p.toUri()).equals(p .toAbsolutePath())

до тех пор, пока исходный Path, URI, и новый Path созданы в (возможно, различных вызовах) одной и той же виртуальной машине Java. Гарантии других провайдеров зависят от провайдера и, следовательно, не определены.

Если файловая система создана для доступа к содержимому файла как к файловой системе, то то, представляет ли возвращаемый URI данный путь в файловой системе, или представляет ли он сложный URI, который кодирует URI содержащей файловой системы, сильно зависит от реализации. Формат сложных URI в этом выпуске не определён; такая схема может быть добавлена в будущей версии.

Path toAbsolutePath()

Возвращает Path объект, представляющий абсолютный путь этого пути.

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

Path toRealPath(LinkOption... options)
         throws IOException

Возвращает действительный путь существующего файла.

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

Если этот путь относительный, то сначала получается его абсолютный путь, как если бы был вызван метод toAbsolutePath.

Массив options может использоваться для указания того, как обрабатываются символические ссылки. По умолчанию символические ссылки разрешаются до их конечной цели. Если опция NOFOLLOW_LINKS присутствует, то этот метод не разрешает символические ссылки. Некоторые реализации позволяют специальные имена, такие как "..", чтобы ссылаться на родительский каталог. При выводе действительного пути, если ".." (или эквивалент) предшествует имени, которое не является ".." именем, то реализация обычно вызывает удаление обоих имён. Когда символические ссылки не разрешаются, и имя, стоящее перед ним - это символическая ссылка, тогда имена удаляются только в том случае, если гарантируется, что результирующий путь указывает на тот же файл, что и этот путь.

File toFile()

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

Если этот путь был создан путем вызова метода File toPath, то нет гарантии, что объект File , возвращаемый этим методом, будет equal исходному объекту File.

WatchKey register(WatchService watcher,
                  WatchEvent.Kind<?>[] events,
                  WatchEvent.Modifier... modifiers)
           throws IOException

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

В этом выпуске этот путь указывает на существующий каталог. Каталог регистрируется в службе мониторинга, чтобы можно было отслеживать элементы в каталоге. Параметр events — это события для регистрации и может содержать следующие события:

• ENTRY_CREATE - элемент создан или перемещен в каталог
• ENTRY_DELETE - элемент удален или перемещен из каталога
• ENTRY_MODIFY - элемент в каталоге был изменен

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

Набор событий может включать дополнительные специфичные для реализации события, которые не определены перечислением StandardWatchEventKinds

Параметр modifiers указывает модификаторы, которые квалифицируют способ регистрации каталога. В этом выпуске стандартные модификаторы не определены. Он может содержать модификаторы, специфичные для реализации.

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

WatchKey register(WatchService watcher,
                  WatchEvent.Kind<?>... events)
           throws IOException

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

Вызов этого метода ведет себя точно так же, как вызов

watchable.register(watcher, events, new WatchEvent.Modifier[0]);

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

Path dir = ...
     WatchService watcher = ...

     WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);

Iterator<Path> iterator()

Возвращает итератор по элементам имени этого пути.

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

int compareTo(Path other)

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

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

boolean equals(Object other)

Проверяет равенство этого пути данному объекту.

Если данный объект не является объектом Path или является объектом Path, связанным с другим FileSystem, то этот метод возвращает false.

Равенство двух путей зависит от реализации файловой системы. В некоторых случаях пути сравниваются без учета регистра, в других — регистрозависимо. Для проверки, указывают ли два пути на один и тот же файл, может использоваться метод isSameFile.

Этот метод удовлетворяет общему контракту метода Object.equals.

int hashCode()

Вычисляет хэш-код для этого пути.

Хэш-код основан на компонентах пути и удовлетворяет общему контракту метода Object.hashCode.

String toString()

Возвращает строковое представление этого пути.

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

Возвращаемая строка пути использует разделитель имен по умолчанию separator для разделения имен в пути.