avail/avail.builder/ModuleName

ModuleName

open class ModuleName constructor(val qualifiedName: String, val isRename: Boolean = false)

A ModuleName represents the canonical name of an Avail module. A canonical name is specified relative to an Avail module root and has the form R/X/Y/Z, where R is a module root on the Avail module path, X is a package within R, Y is a package within X, and Z is a module or package within Y.

Author

Todd L Smith

Parameters

qualifiedName

A fully-qualified module name.

isRename

Whether module resolution followed a renaming rule.

Throws

kotlin.IllegalArgumentException

If the argument was malformed.

Constructors

fun ModuleName( packageName: String, localName: String, isRename: Boolean = false)

Construct a new ModuleName from the specified canonical module group name and local name.

fun ModuleName(qualifiedName: String, isRename: Boolean = false)

Construct a new ModuleName from the specified fully-qualified module name.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String

Properties

val isRename: Boolean = false

true iff this module name was transformed via a rename rule.

val localName: String

The local name of the module referenced by this ModuleName.

val packageName: String

The fully-qualified package name of the ModuleName.

val qualifiedName: String

The fully-qualified module name.

val rootName: String

The logical root name of the ModuleName.

rootRelativeName

val rootRelativeName: String

The lazily-initialized root-relative ModuleName. This is the fully-qualified name minus the rootName.

Inheritors

ResolvedModuleName