gradle/org.gradle.util/Path

Path

open class Path : Comparable<Path> (source)

Represents a path in Gradle.

Since

0.9

Properties

ROOT

val ROOT: Path

Path.

SEPARATOR

val SEPARATOR: String = ":"

The separator.

Functions

absolutePath

open fun absolutePath(path: String): String

Resolves the given name relative to this path.

open fun absolutePath(path: Path): Path

Absolute path.

ancestors

@Incubating

open fun ancestors(): Iterable<Path>

Iterate over all ancestors of this path, starting with the root path (if absolute) or the first segment (if relative) and not including this path.

append

open fun append(path: Path): Path

Appends the supplied path to this path, returning the new path.

asString

open fun asString(): String

Returns the full path as a string.

child

open fun child(name: String): Path

Creates a child of this path with the given name.

compareTo

open fun compareTo(other: Path): Int

equals

open fun equals(@Nullable o: @Nullable Any): Boolean

getName

@Nullable

open fun getName(): @Nullable String

Returns the base name of this path, or null if this path is the root path.

getParent

@Nullable

open fun getParent(): @Nullable Path

Returns the parent of this path, or null if this path has no parent.

getPath

open fun ~~getPath~~(): String

Returns string representation of this path.

hashCode

open fun hashCode(): Int

isAbsolute

open fun isAbsolute(): Boolean

Returns whether absolute is set.

path

open fun path(@Nullable path: @Nullable String): Path

Path.

relativePath

open fun relativePath(path: String): String

Calculates a path relative to this path.

open fun relativePath(path: Path): Path

Relative path.

removeFirstSegments

open fun removeFirstSegments(n: Int): Path

Remove first segments.

segment

open fun segment(index: Int): String

Segment.

segmentCount

open fun segmentCount(): Int

Segment count.

segments

@Incubating

open fun segments(): List<String>

returns an immutable list of the segments of this path

startsWith

@Incubating

open fun startsWith(other: Path): Boolean

Determines if this path starts with the given path.

takeFirstSegments

@Incubating

open fun takeFirstSegments(n: Int): Path

Returns a Path containing only the first n segments of this Path.

toString

open fun toString(): String

validatePath

@Incubating

open fun validatePath(@Nullable path: @Nullable String)

throws if no path is specified