JkPathSequence

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<java.nio.file.Path>
```
public final class JkPathSequence
extends java.lang.Object
implements java.lang.Iterable<java.nio.file.Path>, java.io.Serializable
```
A sequence of file path (folder or archive). Each file is called an entry.
Instances of this class are immutable.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JkPathSequence`	`and(java.lang.Iterable<java.nio.file.Path> otherEntries)` Returns a `JkPathSequence` made of, in the order, the entries of this one plus the specified ones.
`JkPathSequence`	`and(java.nio.file.Path path1, java.nio.file.Path path2, java.nio.file.Path... others)`
`JkPathSequence`	`andPrepend(java.lang.Iterable<java.nio.file.Path> paths)` Returns a `JkPathSequence` made of the specified entries followed by the sequence entries of this object.
`JkPathSequence`	`andPrepend(java.nio.file.Path path1, java.nio.file.Path path2, java.nio.file.Path... entries)`
`boolean`	`equals(java.lang.Object o)`
`java.nio.file.Path`	`findEntryContainingClass(java.lang.String className)` Returns the first entry of this `classpath` containing the given class.
`java.util.List<java.nio.file.Path>`	`getEntries()` Returns this sequence as a list.
`java.nio.file.Path`	`getEntry(int index)`
`int`	`hashCode()`
`boolean`	`hasNonExisting()`
`java.util.Iterator<java.nio.file.Path>`	`iterator()`
`JkPathSequence`	`normalized()`
`static JkPathSequence`	`of()`
`static JkPathSequence`	`of(java.lang.Iterable<java.nio.file.Path> paths)` Creates a `JkPathSequence` from an `Iterable` of paths or a single Path.
`static JkPathSequence`	`of(java.nio.file.Path path1, java.nio.file.Path path2, java.nio.file.Path... others)` Creates a `JkPathSequence` form specified entries
`static JkPathSequence`	`of(java.nio.file.Path baseDir, java.lang.String relativePathsAsString)` Creates a `JkPathSequence` from a base directory and string of relative paths separated with a ";".
`static JkPathSequence`	`ofPathString(java.lang.String pathString)`
`static JkPathSequence`	`ofSysPropClassPath()` Returns the current classpath as given by `System.getProperty("java.class.path")`.
`static JkPathSequence`	`readFrom(java.nio.file.Path path)` Reads the contents of a file at the given path and returns a JkPathSequence object representing the paths extracted from the file contents.
`static JkPathSequence`	`readFromQuietly(java.nio.file.Path path)` Same as `readFrom(java.nio.file.Path)` but returns an empty {@link JkPathSequence if the file does not exist.
`JkPathSequence`	`relativizeFromWorkingDir()` Returns an identical path sequence but replacing relative paths with absolute paths resolved from the specified base directory.
`JkPathSequence`	`resolvedTo(java.nio.file.Path baseDir)` Returns an identical path sequence but replacing relative paths with absolute paths resolved from the specified base directory.
`java.lang.String`	`toColonSeparatedPath()` Returns the file names concatenated with ':'
`java.lang.String`	`toPath()` Returns the file names concatenated with ';' on Windows and ':' on unix.
`java.lang.String`	`toPathMultiLine(java.lang.String margin)`
`java.util.Set<java.nio.file.Path>`	`toSet()`
`java.lang.String`	`toString()`
`java.net.URL[]`	`toUrls()`
`JkPathSequence`	`withoutDuplicates()` Returns a `JkPathSequence` identical to this one but without duplicates.
`void`	`writeTo(java.nio.file.Path path)` Writes the contents of this JkPathSequence to the specified file path.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - of
```
public static JkPathSequence of(java.lang.Iterable<java.nio.file.Path> paths)
```
    Creates a JkPathSequence from an Iterable of paths or a single Path.
    
    Parameters:
    
    paths - As Path class implements { @link Iterable } the argument can be a single Path instance, if so it will be interpreted as a list containing a single element which is this argument.
  - of
```
public static JkPathSequence of()
```
  - readFrom
```
public static JkPathSequence readFrom(java.nio.file.Path path)
```
    Reads the contents of a file at the given path and returns a JkPathSequence object representing the paths extracted from the file contents. The file content is supposed to be have been written using writeTo(java.nio.file.Path)
    
    Throws:
    
    java.io.UncheckedIOException - if the file does not exist.
  - readFromQuietly
```
public static JkPathSequence readFromQuietly(java.nio.file.Path path)
```
    Same as readFrom(java.nio.file.Path) but returns an empty {@link JkPathSequence if the file does not exist.
  - ofPathString
```
public static JkPathSequence ofPathString(java.lang.String pathString)
```
  - of
```
public static JkPathSequence of(java.nio.file.Path baseDir,
                                java.lang.String relativePathsAsString)
```
    Creates a JkPathSequence from a base directory and string of relative paths separated with a ";".
  - of
```
public static JkPathSequence of(java.nio.file.Path path1,
                                java.nio.file.Path path2,
                                java.nio.file.Path... others)
```
    Creates a JkPathSequence form specified entries
  - ofSysPropClassPath
```
public static JkPathSequence ofSysPropClassPath()
```
    Returns the current classpath as given by System.getProperty("java.class.path").
  - withoutDuplicates
```
public JkPathSequence withoutDuplicates()
```
    Returns a JkPathSequence identical to this one but without duplicates. If a given file in this sequence exist twice or more, then only the first occurrence is kept in the returned sequence.
  - normalized
```
public JkPathSequence normalized()
```
  - getEntries
```
public java.util.List<java.nio.file.Path> getEntries()
```
    Returns this sequence as a list.
  - getEntry
```
public java.nio.file.Path getEntry(int index)
```
  - iterator
```
public java.util.Iterator<java.nio.file.Path> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.nio.file.Path>
  - andPrepend
```
public JkPathSequence andPrepend(java.nio.file.Path path1,
                                 java.nio.file.Path path2,
                                 java.nio.file.Path... entries)
```
    See Also:
    
    andPrepend(Iterable)
  - andPrepend
```
public JkPathSequence andPrepend(java.lang.Iterable<java.nio.file.Path> paths)
```
    Returns a JkPathSequence made of the specified entries followed by the sequence entries of this object.
    
    Parameters:
    
    paths - As Path class implements { @link Iterable } the argument can be a single Path instance, if so it will be interpreted as a list containing a single element which is this argument.
  - and
```
public JkPathSequence and(java.nio.file.Path path1,
                          java.nio.file.Path path2,
                          java.nio.file.Path... others)
```
    See Also:
    
    and(Iterable)
  - and
```
public JkPathSequence and(java.lang.Iterable<java.nio.file.Path> otherEntries)
```
    Returns a JkPathSequence made of, in the order, the entries of this one plus the specified ones.
  - resolvedTo
```
public JkPathSequence resolvedTo(java.nio.file.Path baseDir)
```
    Returns an identical path sequence but replacing relative paths with absolute paths resolved from the specified base directory.
  - relativizeFromWorkingDir
```
public JkPathSequence relativizeFromWorkingDir()
```
    Returns an identical path sequence but replacing relative paths with absolute paths resolved from the specified base directory.
  - toPath
```
public java.lang.String toPath()
```
    Returns the file names concatenated with ';' on Windows and ':' on unix.
  - toColonSeparatedPath
```
public java.lang.String toColonSeparatedPath()
```
    Returns the file names concatenated with ':'
  - toPathMultiLine
```
public java.lang.String toPathMultiLine(java.lang.String margin)
```
  - toSet
```
public java.util.Set<java.nio.file.Path> toSet()
```
  - toUrls
```
public java.net.URL[] toUrls()
```
  - hasNonExisting
```
public boolean hasNonExisting()
```
  - findEntryContainingClass
```
public java.nio.file.Path findEntryContainingClass(java.lang.String className)
```
    Returns the first entry of this classpath containing the given class.
  - writeTo
```
public void writeTo(java.nio.file.Path path)
```
    Writes the contents of this JkPathSequence to the specified file path.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class JkPathSequence

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

of

of

readFrom

readFromQuietly

ofPathString

of

of

ofSysPropClassPath

withoutDuplicates

normalized

getEntries

getEntry

iterator

andPrepend

andPrepend

and

and

resolvedTo

relativizeFromWorkingDir

toPath

toColonSeparatedPath

toPathMultiLine

toSet

toUrls

hasNonExisting

findEntryContainingClass

writeTo

toString

equals

hashCode