gradle/org.gradle.api.file/RelativePath

RelativePath

open class RelativePath : Serializable, Comparable<T> , CharSequence(source)

Represents a relative path from some base directory to a file. Used in file copying to represent both a source and target file path when copying files.

RelativePath instances are immutable.

Constructors

RelativePath

constructor(endsWithFile: Boolean, segments: Array<String>)

Creates a RelativePath.

Properties

EMPTY_ROOT

val EMPTY_ROOT: RelativePath

segments

val segments: Array<String>

Functions

append

open fun append(other: RelativePath): RelativePath

Appends the given path to the end of this path.

open fun append(endsWithFile: Boolean, segments: Array<String>): RelativePath

Appends the given names to the end of this path.

charAt

open fun charAt(index: Int): Char

chars

open fun chars(): IntStream

codePoints

open fun codePoints(): IntStream

compare

open fun compare(cs1: CharSequence, cs2: CharSequence): Int

compareTo

open fun compareTo(o: RelativePath): Int

equals

open fun equals(o: Any): Boolean

getFile

open fun getFile(baseDir: File): File

getLastName

open fun getLastName(): String

getParent

open fun getParent(): RelativePath

Returns the parent of this path.

getPathString

open fun getPathString(): String

hashCode

open fun hashCode(): Int

isEmpty

open fun isEmpty(): Boolean

isFile

open fun isFile(): Boolean

length

open fun length(): Int

parse

open fun parse(isFile: Boolean, path: String): RelativePath

open fun parse(isFile: Boolean, @Nullable parent: RelativePath, path: String): RelativePath

plus

open fun plus(other: RelativePath): RelativePath

Appends the given path to the end of this path.

prepend

open fun prepend(segments: Array<String>): RelativePath

Prepends the given names to the start of this path.

replaceLastName

open fun replaceLastName(name: String): RelativePath

Returns a copy of this path, with the last name replaced with the given name.

segmentIterator

open fun segmentIterator(): ListIterator<String>

subSequence

open fun subSequence(start: Int, end: Int): CharSequence

toString

open fun toString(): String