JkPathFile

java.lang.Object
- dev.jeka.core.api.file.JkPathFile

```
public final class JkPathFile
extends java.lang.Object
```
A path standing for a file (not a directory). This class provides path methods relevant for files only.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assertExist()`
`JkPathFile`	`copyReplacingTokens(java.nio.file.Path to, java.util.Map<java.lang.String,java.lang.String> tokens, java.nio.charset.Charset charset)` Creates a copy of this file replacing all occurrences of specified map keys by their matching value.
`JkPathFile`	`copyToDir(java.nio.file.Path dir, java.nio.file.CopyOption... options)` Copies this file to the specified directory.
`JkPathFile`	`createChecksumFiles(java.lang.String... algorithms)` Creates sibling files containing the checksum of this file.
`JkPathFile`	`createIfNotExist()` Creates a file at this location if such file does not exist yet.
`JkPathFile`	`deleteIfExist()` Deletes this file if exists.
`void`	`dos2Unix(java.nio.file.Path target)`
`boolean`	`exists()` Returns `true` if a file already exists at this location.
`JkPathFile`	`fetchContentFrom(java.lang.String urlString)` Gets the contents of the specified url, and write it to this file.
`JkPathFile`	`fetchContentFrom(java.net.URL url)` Copies the content of the specified url into this file, replacing the previous content.
`java.nio.file.Path`	`get()` Returns the underlying path.
`java.lang.String`	`getChecksum(java.lang.String algorithm)` Returns an ASCII string representation of the checksum of this file for the specified algorithm.
`java.lang.String`	`getExtension()`
`JkPathFile`	`move(java.nio.file.Path to, java.nio.file.CopyOption... options)` Moves this file to the specified file location
`static JkPathFile`	`of(java.nio.file.Path path)` Creates a `JkPathFile` instance from the specified path.
`static JkPathFile`	`of(java.lang.String path)`
`static JkPathFile`	`of(java.net.URL url)`
`static JkPathFile`	`ofTemp(java.lang.String prefix, java.lang.String extension, java.nio.file.attribute.FileAttribute... fileAttributes)` Creates a temp file wrapped by a JkPathFile.
`java.util.List<java.lang.String>`	`readAsLines()` Returns the content of this file as a List of strings, where each element represents a line in the file.
`java.lang.String`	`readAsString()` Returns the content of this file as a String encoded in UTF-8
`JkPathFile`	`setPosixExecPermissions()`
`JkPathFile`	`setPosixExecPermissions(boolean owner, boolean group, boolean other)` Adds execute permissions on this file.
`java.lang.String`	`toString()`
`JkPathFile`	`touch()` Updates the last modified time of the underlying file to the current time.
`JkPathFile`	`write(byte[] bytes, java.nio.file.OpenOption... options)` Shorthand for `Files.write(Path, byte[], OpenOption...)`
`JkPathFile`	`write(java.lang.String contentUtf8, java.nio.file.OpenOption... options)` Writes the specified UTF-8 encoded String to this file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static JkPathFile of(java.nio.file.Path path)
```
    Creates a JkPathFile instance from the specified path.
  - of
```
public static JkPathFile of(java.lang.String path)
```
    See Also:
    
    of(Path)
  - of
```
public static JkPathFile of(java.net.URL url)
```
  - ofTemp
```
public static JkPathFile ofTemp(java.lang.String prefix,
                                java.lang.String extension,
                                java.nio.file.attribute.FileAttribute... fileAttributes)
```
    Creates a temp file wrapped by a JkPathFile.
  - get
```
public java.nio.file.Path get()
```
    Returns the underlying path.
  - createIfNotExist
```
public JkPathFile createIfNotExist()
```
    Creates a file at this location if such file does not exist yet.
  - copyReplacingTokens
```
public JkPathFile copyReplacingTokens(java.nio.file.Path to,
                                      java.util.Map<java.lang.String,java.lang.String> tokens,
                                      java.nio.charset.Charset charset)
```
    Creates a copy of this file replacing all occurrences of specified map keys by their matching value. Keys may value '${my.key.1}', '[myKey]' or whatever.
  - copyToDir
```
public JkPathFile copyToDir(java.nio.file.Path dir,
                            java.nio.file.CopyOption... options)
```
    Copies this file to the specified directory. If the specified directory does not exist, it is created.
  - move
```
public JkPathFile move(java.nio.file.Path to,
                       java.nio.file.CopyOption... options)
```
    Moves this file to the specified file location
    
    Parameters:
    
    to - The destination file path. This is not the parent directory destination.
  - fetchContentFrom
```
public JkPathFile fetchContentFrom(java.net.URL url)
```
    Copies the content of the specified url into this file, replacing the previous content. A file is created silently if not already exists.
  - fetchContentFrom
```
public JkPathFile fetchContentFrom(java.lang.String urlString)
```
    Gets the contents of the specified url, and write it to this file. A file is created silently if not already exists.
    
    See Also:
    
    fetchContentFrom(URL)
  - exists
```
public boolean exists()
```
    Returns true if a file already exists at this location.
  - deleteIfExist
```
public JkPathFile deleteIfExist()
```
    Deletes this file if exists.
  - getChecksum
```
public java.lang.String getChecksum(java.lang.String algorithm)
```
    Returns an ASCII string representation of the checksum of this file for the specified algorithm.
    
    Parameters:
    
    algorithm - Hashing algorithm as MD5, SHA-2, ...
  - write
```
public JkPathFile write(byte[] bytes,
                        java.nio.file.OpenOption... options)
```
    Shorthand for Files.write(Path, byte[], OpenOption...)
  - write
```
public JkPathFile write(java.lang.String contentUtf8,
                        java.nio.file.OpenOption... options)
```
    Writes the specified UTF-8 encoded String to this file.
  - readAsString
```
public java.lang.String readAsString()
```
    Returns the content of this file as a String encoded in UTF-8
  - readAsLines
```
public java.util.List<java.lang.String> readAsLines()
```
    Returns the content of this file as a List of strings, where each element represents a line in the file.
  - createChecksumFiles
```
public JkPathFile createChecksumFiles(java.lang.String... algorithms)
```
    Creates sibling files containing the checksum of this file. Checksum files are created in the same directory as this file.
  - setPosixExecPermissions
```
public JkPathFile setPosixExecPermissions(boolean owner,
                                          boolean group,
                                          boolean other)
```
    Adds execute permissions on this file. No effect on Windows system.
  - setPosixExecPermissions
```
public JkPathFile setPosixExecPermissions()
```
  - touch
```
public JkPathFile touch()
```
    Updates the last modified time of the underlying file to the current time. If the file does not exist, this method has no effect.
    
    Returns:
    
    The current JkPathFile instance, allowing method chaining.
  - assertExist
```
public void assertExist()
```
  - getExtension
```
public java.lang.String getExtension()
```
  - dos2Unix
```
public void dos2Unix(java.nio.file.Path target)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class JkPathFile

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

of

ofTemp

get

createIfNotExist

copyReplacingTokens

copyToDir

move

fetchContentFrom

fetchContentFrom

exists

deleteIfExist

getChecksum

write

write

readAsString

readAsLines

createChecksumFiles

setPosixExecPermissions

setPosixExecPermissions

touch

assertExist

getExtension

dos2Unix

toString