Liking cljdoc? Tell your friends :D

org.soulspace.clj.java.file

Functions for working with files and directories.

Functions for working with files and directories.
raw docstring

absolute-fileclj

(absolute-file file)

Returns the file as absolute file.

Returns the file as absolute file.
sourceraw docstring

absolute-pathclj

(absolute-path file)

Returns the absolute path of the file.

Returns the absolute path of the file.
sourceraw docstring

all-filesclj

(all-files file)

Returns a sequence of the files in a directory given as file and its sub directories. If the given file is not a directory, it is returned as only file in the sequence.

Returns a sequence of the files in a directory given as file and its sub directories.
If the given file is not a directory, it is returned as only file in the sequence.
sourceraw docstring

all-files-by-extensionclj

(all-files-by-extension ext file)

Returns a sequence of the files with the extension ext in a directory given as file and its sub directories. If the given file is not a directory, it is returned as only file in the sequence.

Returns a sequence of the files with the extension ext in a directory given as file and its sub directories.
If the given file is not a directory, it is returned as only file in the sequence.
sourceraw docstring

all-files-by-patternclj

(all-files-by-pattern pattern file)

Returns a sequence of the files that match the pattern in a directory given as file and its sub directories. If the given file is not a directory, it is returned as only file in the sequence.

Returns a sequence of the files that match the pattern in a directory given as file and its sub directories.
If the given file is not a directory, it is returned as only file in the sequence.
sourceraw docstring

base-nameclj

(base-name file)

Returns the name of the file.

Returns the name of the file.
sourceraw docstring

build-absolute-pathclj

(build-absolute-path dir filename)
(build-absolute-path dir filename extension)

Returns the absolute path of the file defined by the given directory, filename (and extension).

Returns the absolute path of the file defined by the given directory, filename (and extension).
sourceraw docstring

build-pathclj

(build-path files)
(build-path sep files)

Build a path by joining the given files with the separator or ':' as default.

Build a path by joining the given files with the separator or ':' as default.
sourceraw docstring

build-searchpathclj

(build-searchpath pathnames)

Creates a sequence containing the directories to search.

Creates a sequence containing the directories to search.
sourceraw docstring

canonical-fileclj

(canonical-file file)

Returns the canonical file of the file.

Returns the canonical file of the file.
sourceraw docstring

canonical-pathclj

(canonical-path file)

Returns the canonical path of the file.

Returns the canonical path of the file.
sourceraw docstring

create-dirclj

(create-dir file)

Creates a directory including missing parent directories.

Creates a directory including missing parent directories.
sourceraw docstring

delete-dirclj

(delete-dir file)

Deletes the directory and any subdirectories.

Deletes the directory and any subdirectories.
sourceraw docstring

delete-fileclj

(delete-file file)

Deletes the file.

Deletes the file.
sourceraw docstring

directory-searcherclj

(directory-searcher filename)
(directory-searcher filename extension)

Returns a function that takes a directory and returns the file specified by filename (and extension).

Returns a function that takes a directory and returns the file specified by filename (and extension).
sourceraw docstring

executable?clj

(executable? file)

Returns true, if the given file is executable.

Returns true, if the given file is executable.
sourceraw docstring

existing-filesclj

(existing-files dirs)
(existing-files ext dirs)

Returns all existing files (with the specified extension) in the given directories.

Returns all existing files (with the specified extension) in the given directories.
sourceraw docstring

existing-files-by-patternclj

(existing-files-by-pattern pattern dirs)

Returns all existing files matching the specified pattern in the given directories.

Returns all existing files matching the specified pattern in the given directories.
sourceraw docstring

existing-files-on-pathclj

(existing-files-on-path dir-path)
(existing-files-on-path ext dir-path)

Returns all existing files (with the specified extension) on the given path.

Returns all existing files (with the specified extension) on the given path.
sourceraw docstring

exists?clj

(exists? file)

Returns true, if the given file exists.

Returns true, if the given file exists.
sourceraw docstring

file-locatorclj

(file-locator searchpath)
(file-locator searchpath ext)

Returns a function that locates a file by name on the search path.

Returns a function that locates a file by name on the search path.
sourceraw docstring

file-nameclj

(file-name file)

Returns the name of the file.

Returns the name of the file.
sourceraw docstring

filesclj

(files file)

Returns a sequence of the files in a directory given as file. If the given file is not a directory, it is returned as only file in the sequence.

Returns a sequence of the files in a directory given as file.
If the given file is not a directory, it is returned as only file in the sequence.
sourceraw docstring

files-by-extensionclj

(files-by-extension ext file)

Returns a sequence of the files with the extension ext in a directory given as file. If the given file is not a directory, it is returned as only file in the sequence.

Returns a sequence of the files with the extension ext in a directory given as file.
If the given file is not a directory, it is returned as only file in the sequence.
sourceraw docstring

has-extension?clj

(has-extension? ext file)

Returns true if the path of the file ends with the given extension.

Returns true if the path of the file ends with the given extension.
sourceraw docstring

is-dir?clj

(is-dir? file)

Returns true, if the given file exists and is a directory.

Returns true, if the given file exists and is a directory.
sourceraw docstring

is-file?clj

(is-file? file)

Returns true, if the given file exists and is a directory.

Returns true, if the given file exists and is a directory.
sourceraw docstring

locate-fileclj

(locate-file searchpath filename)
(locate-file searchpath filename extension)

Returns the first existing file on the search path for the specified filename (and extension).

Returns the first existing file on the search path for the specified filename (and extension).
sourceraw docstring

matches?clj

(matches? pattern file)

Returns true if the path of the file matches the given pattern.

Returns true if the path of the file matches the given pattern.
sourceraw docstring

normalize-pathclj

(normalize-path path)

Returns the normalized path (unix convention) of the path.

Returns the normalized path (unix convention) of the path.
sourceraw docstring

normalized-pathclj

(normalized-path file)

Returns the normalized path (unix convention) of the file.

Returns the normalized path (unix convention) of the file.
sourceraw docstring

parent-dirclj

(parent-dir file)

Returns the parent dir of the file if it exists.

Returns the parent dir of the file if it exists.
sourceraw docstring

parent-pathclj

(parent-path file)

Returns the parent path for the file if it exists.

Returns the parent path for the file if it exists.
sourceraw docstring

pathclj

(path file)

Returns the path of the file.

Returns the path of the file.
sourceraw docstring

path-patternclj

(path-pattern ant-pattern)

Convert ant style path patterns to regex path patterns.

Convert ant style path patterns to regex path patterns.
sourceraw docstring

readable?clj

(readable? file)

Returns true, if the given file is readable.

Returns true, if the given file is readable.
sourceraw docstring

relative-pathclj

(relative-path base-path file)

Returns the path of the file relative to the base-path.

Returns the path of the file relative to the base-path.
sourceraw docstring

split-pathclj

(split-path paths)
(split-path sep paths)

Split a path string with the given separator or ':' as default.

Split a path string with the given separator or ':' as default.
sourceraw docstring

writeable?clj

(writeable? file)

Returns true, if the given file is writeable.

Returns true, if the given file is writeable.
sourceraw docstring

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

× close