pathological.paths

Liking cljdoc? Tell your friends :D

Clojure only.

->absolute-path
->file
->real-path
->uri
absolute?
ends-with?
file-name
file-store
file-system
matches?
name
name-count
names
normalize
parent
path
Pathable
relativize
resolve
resolve-sibling
root
starts-with?
subpath

->absolute-path^clj

(->absolute-path path)

->file^clj

(->file path)

->real-path^clj

(->real-path path & options)

->uri^clj

(->uri path)

absolute?^clj

(absolute? path)

ends-with?^cljmultimethod

file-name^clj

(file-name path)

Returns the file or directory name for the path, i.e., the name element furthers to the right, as a Path instance.

Returns null if there is no file or directory name.

See the Java documentation for more details.

Returns the file or directory name for the `path`, i.e., the name element
furthers to the right, as a
[Path](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html)
instance.

Returns `null` if there is no file or directory name.

See [the Java documentation](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html#getFileName%28%29)
for more details.

raw docstring

file-store^clj

(file-store path)

Returns the FileStore on which the path is stored.

See the Java documentation

Returns the [FileStore](https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileStore.html)
on which the `path` is stored.

See [the Java documentation](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Files.html#getFileStore%28java.nio.file.Path%29)

raw docstring

file-system^clj

(file-system path)

Returns the FileSystem associated with the path.

See the Java documentation for more details.

Returns the [FileSystem](https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html)
associated with the `path`.

See [the Java documentation](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html#getFileSystem%28%29)
for more details.

raw docstring

matches?^clj

(matches? path syntax-and-pattern)

name^clj

(name path index)

Returns the name element in the path at the index.

index represents the offset of the name element from the root and must be non-negative and less than the number of elements or an IllegalArgumentException is thrown.

See the Java documentation for more details.

Returns the name element in the `path` at the `index`.

`index` represents the offset of the name element from the root and must be
non-negative and less than the number of elements or an
[IllegalArgumentException](...) is thrown.

See [the Java documentation](...)
for more details.

raw docstring

name-count^clj

(name-count path)

Returns the number of name elements in the path.

Returns 0 if the path is a root component.

See the Java documentation for more details.

Returns the number of name elements in the `path`.

Returns `0` if the `path` is a root component.

See [the Java documentation](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html#getFileName%28%29)
for more details.

raw docstring

names^clj

(names path)

Returns a seq over all the name elements in the path, iterating forwards through the path from the root component.

See the Java documentation for more details.

Returns a seq over all the name elements in the `path`, iterating
forwards through the path from the root component.

See [the Java documentation](...)
for more details.

raw docstring

normalize^clj

(normalize path)

parent^clj

(parent path)

Returns the parent path for the path, i.e., the path without the name element furthest to the right, as a Path instance.

Returns null if there is no parent path.

See the Java documentation for more details.

Returns the parent path for the `path`, i.e., the path without the name
element furthest to the right, as a
[Path](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html)
instance.

Returns `null` if there is no parent path.

See [the Java documentation](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html#getParent%28%29)
for more details.

raw docstring

path^clj

(path & [pathable & names])

Creates a Path instance.

Receives a Pathable instance and zero or more path name elements. By default, Pathable is implemented on:

FileSystem: in which case the name elements constitute the full path on the provided file system,
Path: in which case the name elements are appended to the path retaining the file system from the path,
String: in which case the name elements are appended to the path represented by the string, using pathological.file-systems/*file-system* as the file system for the path,
URI: in which case the scheme of the URI is used to look up the file system in the installed providers and the name elements are appended to the URI to determine the path.

Creates a [Path](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html)
instance.

Receives a [[Pathable]] instance and zero or more path name elements. By
default, [[Pathable]] is implemented on:

  - [FileSystem](https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html):
    in which case the name elements constitute the full path on the provided
    file system,
  - [Path](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html):
    in which case the name elements are appended to the path retaining the
    file system from the path,
  - [String](https://docs.oracle.com/javase/7/docs/api/java/lang/String.html):
    in which case the name elements are appended to the path represented by
    the string, using [[pathological.file-systems/*file-system*]] as the file
    system for the path,
  - [URI](https://docs.oracle.com/javase/7/docs/api/java/net/URI.html): in
    which case the scheme of the URI is used to look up the file system in
    the installed providers and the name elements are appended to the URI
    to determine the path.

raw docstring

Pathable^cljprotocol

A protocol for converting things to Paths.

Used by path with default implementations for:

See path for more details.

A protocol for converting things to [Path](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html)s.

Used by [[path]] with default implementations for:

  - [FileSystem](https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html),
  - [Path](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html),
  - [String](https://docs.oracle.com/javase/7/docs/api/java/lang/String.html),
  - [URI](https://docs.oracle.com/javase/7/docs/api/java/net/URI.html)

See [[path]] for more details.

->path^clj

(->path this names)

Produces a path for the instance and sequence of path name elements.

Produces a path for the instance and sequence of path name elements.

raw docstring

relativize^clj

(relativize base-path path)

resolve^cljmultimethod

resolve-sibling^cljmultimethod

root^clj

(root path)

Returns the root component of the path as a Path instance.

Returns null if there is no root component.

See the Java documentation for more details.

Returns the root component of the `path` as a
[Path](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html)
instance.

Returns `null` if there is no root component.

See [the Java documentation](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html#getRoot%28%29)
for more details.

raw docstring

starts-with?^cljmultimethod

subpath^clj

(subpath path from to)

Returns the subpath within path between the from index inclusive and the to index exclusive.

See the Java documentation for more details.

Returns the subpath within `path` between the `from` index inclusive and the
`to` index exclusive.

See [the Java documentation](https://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html#subpath%28int,%20int%29)
for more details.

raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close