Property Detail

• java.lang.String permissions

• java.lang.String permissions

• java.lang.String permissions

• java.lang.String permissions

Method Detail

• static boolean canExecute(java.nio.file.Path self)

  Tests whether the application can execute the file denoted by this abstract pathname.

  throws:

  SecurityException If a security manager exists and its java.lang.SecurityManager#checkExec(java.lang.String) method denies execute access to the file

  Parameters:

  self

  Returns:

  true if and only if the abstract pathname exists and the application is allowed to execute the file

• static boolean canRead(java.nio.file.Path self)

  Tests whether the application can read the file denoted by this abstract pathname.

  Parameters:

  self

  Returns:

  true if and only if the file specified by this abstract pathname exists and can be read by the application; false otherwise

• static boolean canWrite(java.nio.file.Path self)

  Tests whether the application can modify the file denoted by this abstract pathname.

  Parameters:

  self

  Returns:

  true if and only if the file system actually contains a file denoted by this abstract pathname and the application is allowed to write to the file; false otherwise.

• static void closeQuietly(java.io.Closeable self)

  Close a file in safe manner i.e. without throwing eventual exception raised by the *close* operation

  Parameters:

  self - A Closable object

• static java.nio.file.Path complete(java.nio.file.Path self)

  A shortcut for java.nio.file.Path#toAbsolutePath() and java.nio.file.Path#normalize()

  Parameters:

  self

  Returns:

  An absolute and normalized path

• static java.io.File copyTo(java.io.File source, java.io.File target)

  Copy or a file or a directory content. It mimics the semantic of Linux cp -r <source> <target> command.

  Parameters:

  source - The source file or directory

  target - The target file or directory

  Returns:

  The target java.nio.file.Path file

• static java.nio.file.Path copyTo(java.nio.file.Path source, java.nio.file.Path target)

  Copy a file or a directory content. It mimics the semantic of Linux cp -r <source> <target> command.

  Parameters:

  source - The source file or directory

  target - The target file or directory

  Returns:

  The target java.nio.file.Path file

• static java.io.File copyTo(java.io.File source, java.lang.String target)

  Copy or a file or a directory content. It mimics the semantic of Linux cp -r <source> <target> command.

  Parameters:

  source - The source file or directory

  target - The target file or directory

  Returns:

  The target java.nio.file.Path file

• static java.nio.file.Path copyTo(java.nio.file.Path source, java.lang.String target)

  Copy or a file or a directory content. It mimics the semantic of Linux cp -r <source> <target> command.

  Parameters:

  source - The source file or directory

  target - The target file or directory

  Returns:

  The target java.nio.file.Path file

• static void createDirIfNotExists(java.nio.file.Path target)

  Create a folder if not already exists

  Parameters:

  target - The folder to be created

• static void createDirIfNotExists(java.io.File target)

• static boolean delete(java.nio.file.Path path)

  Deletes the file or directory denoted by this abstract pathname. If this pathname denotes a directory, then the directory must be empty in order to be deleted.

  See Also:

  java.io.File#delete()

• static boolean deleteDir(java.nio.file.Path path)

  Deletes a directory with all contained files and subdirectories.

  The method returns

  • true, when deletion was successful
  • true, when it is called for a non existing directory
  • false, when it is called for a file which isn't a directory
  • false, when directory couldn't be deleted

  Parameters:

  path

  Returns:

• static void deleteOnExit(java.nio.file.Path self)

• static java.nio.file.Path div(java.nio.file.Path path, java.lang.String other)

• static java.nio.file.Path div(java.nio.file.Path path, java.nio.file.Path other)

• static boolean empty(java.io.File file)

  Check if a file - or - a directory is empty

  Parameters:

  file - The file under test

  Returns:

  true if the file does not exist or it is empty

• static boolean empty(java.nio.file.Path path)

  Check if a file - or - a directory is empty

  Parameters:

  file - The file under test

  Returns:

  true if the file does not exist or it is empty

• static boolean exists(java.nio.file.Path self, java.nio.file.LinkOption... options)

• static java.lang.String getBaseName(java.io.File file, int times = 1 )

  Gets the base name, minus the full path and extension, from a full filename. This method will handle a file in either Unix or Windows format. The text after the last forward or backslash and before the last dot is returned.

     a/b/c.txt --> c
     a.txt     --> a
     a/b/c     --> c
   

  The output will be the same irrespective of the machine that the code is running on.

  Parameters:

  file - The filename to query, null returns null

  times - The number of times it checks for the extension to be removed (useful for files with multiple extensions)

  Returns:

  The name of the file without the path, or an empty string if none exists

• static java.lang.String getBaseName(java.nio.file.Path self, int times = 1 )

  Gets the base name, minus the full path and extension, from a full filename. This method will handle a file in either Unix or Windows format. The text after the last forward or backslash and before the last dot is returned.

     a/b/c.txt --> c
     a.txt     --> a
     a/b/c     --> c
   

  The output will be the same irrespective of the machine that the code is running on.

  Parameters:

  file - The filename to query, null returns null

  times - The number of times it checks for the extension to be removed (useful for files with multiple extensions)

  Returns:

  The name of the file without the path, or an empty string if none exists

• static java.lang.String getExtension(java.io.File file)

  Gets the extension of a filename. This method returns the textual part of the filename after the last dot. There must be no directory separator after the dot.

     foo.txt      --> "txt"
     a/b/c.jpg    --> "jpg"
     a/b.txt/c    --> ""
     a/b/c        --> ""
   

  The output will be the same irrespective of the machine that the code is running on.

  Parameters:

  file - The file to retrieve the extension of.

  Returns:

  the Extension of the file or an empty string if none exists

• static java.lang.String getExtension(java.nio.file.Path file)

  Retrieve the file name extension

  Parameters:

  file - A Path referencing a file

  Returns:

  The file name extension (not including the dot) or an empty string if the file has not extension

• static java.lang.String getName(java.nio.file.Path self)

  Extend Path adding a getName method semantically equivalent to File#getName

  Returns:

  The name of the path as string

• static java.lang.String getPermissions(java.nio.file.Path self)

  Get the file Unix permission as a string e.g. rw-r--r--

  Parameters:

  self - The Path for which the permissions string

  Returns:

  Unix permission as a string e.g. rw-r--r--

• static java.lang.String getScheme(java.nio.file.Path path)

• static java.lang.String getSimpleName(java.io.File self)

  Extend File adding a getSimpleName() method which returns the file base name removing all file extension. When a file start starts with a dot character it returns the first name token after the dot. For example:

     a.txt     --> a
     a.tar.gz  --> a
     a/b/c     --> c
     a/b/c.txt --> c
     /         --> null
   

  Parameters:

  self - The file File

  Returns:

  The file simple name string

• static java.lang.String getSimpleName(java.nio.file.Path self)

  Extend Path adding a getSimpleName() method which returns the file base name removing all file extension. When a file start starts with a dot character it returns the first name token after the dot. For example:

     a.txt     --> a
     a.tar.gz  --> a
     a/b/c     --> c
     a/b/c.txt --> c
     /         --> null
   

  Parameters:

  self - The file Path

  Returns:

  The file simple name string

• static java.net.URI getUri(java.nio.file.Path self)

• static java.net.URI getUri(java.io.File self)

• static java.lang.CharSequence head(java.io.Reader reader, int n)

  Read 'n' lines from the beginning of a Reader object.

  The method does not close the reader object, thus the caller has to call the close method on it.

  Parameters:

  reader - The source object from where read the first 'n' lines

  n - The number of lines to read

  Returns:

  The read lines as a CharSequence object

• static java.lang.CharSequence head(java.io.InputStream stream, int n, java.lang.Object charset)

  Read 'n' lines from the beginning of a InputStream object.

  The method does not close the stream object, thus the caller has to call the close method on it.

  Parameters:

  reader - The source object from where read the first 'n' lines

  n - The number of lines to read

  charset - The charset to use, it can be specified by using a string e.g. 'UTF-8' or a Charset object. When null is specified the current default charset is used.

  Returns:

  The read lines as a CharSequence object

• static java.lang.CharSequence head(java.io.File file, int n, java.lang.Object charset = null )

  Read the top from the beginning of a File object, stopping as soon as 'n' lines has been read.

  Parameters:

  file - The source file from where read the first 'n' lines

  n - The number of lines to read

  charset - The charset to use, it can be specified by using a string e.g. 'UTF-8' or a Charset object. When null is specified the current default charset is used.

  Returns:

  The read lines as a CharSequence object

• static java.lang.CharSequence head(java.nio.file.Path path, int n, java.lang.Object charset = null )

  Read the top from the beginning of a Path object, stopping as soon as 'n' lines has been read.

  Parameters:

  path - The source file from where read the first 'n' lines

  n - The number of lines to read

  charset - The charset to use, it can be specified by using a string e.g. 'UTF-8' or a Charset object. When null is specified the current default charset is used.

  Returns:

  The read lines as a CharSequence object

• static boolean isDirectory(java.nio.file.Path self, java.nio.file.LinkOption... options)

• static boolean isFile(java.nio.file.Path self, java.nio.file.LinkOption... options)

• static boolean isHidden(java.nio.file.Path self)

• static boolean isLink(java.nio.file.Path self)

• static long lastModified(java.nio.file.Path self, java.nio.file.LinkOption... options)

  Returns the time that the file denoted by this abstract pathname was last modified.

  Where it is required to distinguish an I/O exception from the case where 0L is returned, or where several attributes of the same file are required at the same time, or where the time of last access or the creation time are required, then the java.nio.file.Files#readAttributes(Path,Class,LinkOption[]) method may be used.

  Returns:

  A long value representing the time the file was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or 0L if the file does not exist or if an I/O error occurs

  Parameters:

  self

  options

• static java.lang.String[] list(java.nio.file.Path self)

  List the content of a given path folder. The method is semantically equivalent to File#list()

  Parameters:

  self - The folder to list

  Returns:

  A list of strings or null if the path is not a folder

• static java.nio.file.Path[] listFiles(java.nio.file.Path self, @groovy.transform.stc.ClosureParams(value = FromString.class, options = ["java.nio.file.Path", "java.nio.file.Path,java.nio.file.attribute.BasicFileAttributes"]) groovy.lang.Closure<java.lang.Boolean> filter = null)

  List the content of a given path folder. The method is semantically equivalent to File#listFiles()

  Parameters:

  self - The folder to list

  Returns:

  A list of Path or null if the path is not a folder

• static boolean matches(java.nio.file.Path self, java.lang.String pattern)

• static boolean matches(java.io.File self, java.lang.String pattern)

• static java.nio.file.Path minus(java.nio.file.Path path, int i)

• static boolean mkdir(java.nio.file.Path self, java.nio.file.attribute.FileAttribute<?>... attr)

  Creates the directory named by this abstract pathname

  Parameters:

  self - The directory to be created

  attr - an optional list of file attributes to set atomically when creating the directory

  Returns:

  true if the directory is created successfully, or false otherwise

• static boolean mkdirs(java.nio.file.Path self, java.nio.file.attribute.FileAttribute<?>... attr)

  Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories

  Parameters:

  self - The path to be created

  attr - an optional list of file attributes to set atomically when creating the directory

  Returns:

  true if the directory is created successfully, or false otherwise

• static java.nio.file.Path mklink(java.nio.file.Path existing, java.util.Map opts, java.nio.file.Path link)

  Make a symbolic or a hard file system link

  Parameters:

  existing - The existing file

  opts - Optional parameters: hard: when true create a hard link, otherwise it creates a symbolic link overwrite

  link - The java.nio.file.Path of the link to create

• static java.nio.file.Path mklink(java.nio.file.Path existing, java.util.Map opts, java.io.File link)

• static java.nio.file.Path mklink(java.nio.file.Path existing, java.util.Map opts, java.lang.String link)

• static java.nio.file.Path mklink(java.nio.file.Path existing, java.nio.file.Path link)

• static java.nio.file.Path mklink(java.nio.file.Path existing, java.io.File link)

• static java.nio.file.Path mklink(java.nio.file.Path existing, java.lang.String link)

• static java.nio.file.Path mklink(java.nio.file.Path existing, java.util.Map opts = null )

• static java.io.File moveTo(java.io.File source, java.io.File target)

  Move a file or a directory. Mimics the Linux *mv* command

  Parameters:

  source

  target

  Returns:

• static java.io.File moveTo(java.io.File source, java.lang.String target)

  Move a file or a directory. Mimics the Linux *mv* command

  Parameters:

  source

  target

  Returns:

• static java.nio.file.Path moveTo(java.nio.file.Path source, java.nio.file.Path target)

  Move a file or a directory. Mimics the Linux *mv* command

  Parameters:

  source

  target

  Returns:

• static java.nio.file.Path moveTo(java.nio.file.Path source, java.lang.String target)

• static java.nio.file.Path or(java.nio.file.Path path, java.lang.String other)

• static java.nio.file.Path or(java.nio.file.Path path, java.nio.file.Path other)

• static java.nio.file.Path plus(java.nio.file.Path path, java.lang.String other)

• static java.nio.file.Path plus(java.nio.file.Path path, java.nio.file.Path other)

• @java.lang.Deprecated static java.nio.file.attribute.BasicFileAttributes readAttributes(java.nio.file.Path path)

• static boolean renameTo(java.nio.file.Path self, java.nio.file.Path target)

• static boolean renameTo(java.nio.file.Path self, java.lang.String target)

• static java.nio.file.Path resolveSymLink(java.nio.file.Path self)

  Resolve a symbolic link to the actual target file, in a similar manner to the Linux readlink -f command.

  It canonicalize by following every symlink in every component of the given name recursively; all but the last component must exist.

  Parameters:

  self

  Returns:

  The resolved target path of the source path itself it is not a file or the file does not exist

• static java.io.File resolveSymLink(java.io.File self)

• static void rollFile(java.nio.file.Path self, int maxRolls = 9 )

  Roll a file moving to a new path whose name ends with .1

  Parameters:

  self - The file itself

  maxRolls - Max number of time to apply the file rolling (i.e. rename to a new name)

• static boolean setExecutable(java.nio.file.Path self, boolean executable, boolean ownerOnly = true)

  Sets the owner's or everybody's execute permission for the specified file.

  Parameters:

  self - The Path for which set the permissions

  executable - If true, sets the access permission to allow execute operations; if false to disallow execute operations

  ownerOnly - If true, the execute permission applies only to the owner's execute permission; otherwise, it applies to everybody. If the underlying file system can not distinguish the owner's execute permission from that of others, then the permission will apply to everybody, regardless of this value.

  Returns:

  true if and only if the operation succeeded. The operation will fail if the user does not have permission to change the access permissions of this file.

• static boolean setLastModified(java.nio.file.Path self, long time)

  Sets the last-modified time of the file or directory named by this Path.

  Parameters:

  self - The Path to which set the last modified time

  time - The new last-modified time, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)

  Returns:

  true if and only if the operation succeeded; false otherwise

• static boolean setPermissions(java.nio.file.Path self, java.lang.String permissions)

  Set the file Unix permissions using a string like rw-r--r--

  Parameters:

  self - The Path file for which set the permissions.

  permissions - The permissions string e.g. rw-r--r--. It must contain 9 letters.

• static boolean setPermissions(java.io.File self, java.lang.String permissions)

  Set the file Unix permissions using a string like rw-r--r--

  Parameters:

  self - The File object for which set the permissions.

  permissions - The permissions string e.g. rw-r--r--. It must contain 9 letters.

• static boolean setPermissions(java.nio.file.Path self, int owner, int group, int other)

  Set the file Unix permission using the digit representing the respectively the permissions for the owner, the group and others.

  link:

  http

  Parameters:

  self - The Path file for which set the permissions

  owner - The owner permissions using a octal numeric representation.

  group - The group permissions using a octal numeric representation.

  other - The others permissions using a octal numeric representation.

• static boolean setPermissions(java.io.File self, int owner, int group, int other)

  Set the file Unix permission using the digit representing the respectively the permissions for the owner, the group and others.

  link:

  http

  Parameters:

  self - The File object for which set the permissions

  owner - The owner permissions using a octal numeric representation.

  group - The group permissions using a octal numeric representation.

  other - The others permissions using a octal numeric representation.

• static boolean setReadOnly(java.nio.file.Path self)

  * Marks the file or directory named by this abstract pathname so that only read operations are allowed.

  Parameters:

  self

  Returns:

• static boolean setReadable(java.nio.file.Path self, boolean readable, boolean ownerOnly = true)

  A convenience method to set the owner's read permission for the specified file

  Parameters:

  self - The Path for which set the readable permissions

  readable - If true, sets the access permission to allow read operations; if false to disallow read operations

  ownerOnly - If true, sets the access permission to allow read operations; if false to disallow read operations

  Returns:

  true if and only if the operation succeeded. The operation will fail if the user does not have permission to change the access permissions of this file.

• static boolean setWritable(java.nio.file.Path self, boolean writable, boolean ownerOnly = true )

  Sets the owner's or everybody's write permission for the specified file.

  Parameters:

  self - The Path for which set the permissions

  writable - If true, sets the access permission to allow write operations; if false to disallow write operations

  ownerOnly - If true, the write permission applies only to the owner's write permission; otherwise, it applies to everybody. If the underlying file system can not distinguish the owner's write permission from that of others, then the permission will apply to everybody, regardless of this value.

  Returns:

  true if and only if the operation succeeded.

• static java.lang.CharSequence tail(java.nio.channels.SeekableByteChannel channel, int n, java.lang.Object charset = null, int blockSize = DEFAULT_TAIL_BLOCK_SIZE )

  Read the last 'n' lines from a SeekableByteChannel without reading the previous content.

  The method does not close the channel object, thus the caller has to close it.

  Parameters:

  channel - The channel from where read the ending lines

  n - The number of lines to be read

  charset - The charset to use, it can be specified by using a string e.g. 'UTF-8' or a Charset object. When null is specified the current default charset is used.

  blockSize - The size of the block read when reading the channel tail

  Returns:

  The 'n' lines as CharSequence object

• static java.lang.CharSequence tail(java.nio.file.Path path, int n, java.lang.Object charset = null, int blockSize = DEFAULT_TAIL_BLOCK_SIZE)

  Read the last 'n' lines from a Path without reading all the file content

  Parameters:

  channel - The channel from where read the ending lines

  n - The number of lines to be read

  charset - The charset to use, it can be specified by using a string e.g. 'UTF-8' or a Charset object. When null is specified the current default charset is used.

  blockSize - The size of the block read when reading the channel tail

  Returns:

  The 'n' lines as CharSequence object

• static java.lang.CharSequence tail(java.io.Reader reader, int n)

  Read the last 'n' lines from a Path without reading all the file content

  Parameters:

  channel - The channel from where read the ending lines

  n - The number of lines to be read

  Returns:

  The 'n' lines as CharSequence object

• static java.lang.CharSequence tail(java.io.InputStream stream, int n, java.lang.Object charset)

• static java.lang.CharSequence tail(java.io.File file, int n, java.lang.Object charset = null, int blockSize = DEFAULT_TAIL_BLOCK_SIZE )

  Read the last 'n' lines from a File without reading all the file content

  Parameters:

  channel - The channel from where read the ending lines

  n - The number of lines to be read

  charset - The charset to use, it can be specified by using a string e.g. 'UTF-8' or a Charset object. When null is specified the current default charset is used.

  blockSize - The size of the block read when reading the channel tail

  Returns:

  The 'n' lines as CharSequence object

• static java.lang.String toUriString(java.nio.file.Path path)