main

cpg-core/de.fraunhofer.aisec.cpg.graph/Name

Name

class Name(val localName: String, val parent: Name? = null, val delimiter: String = ".") : Cloneable, Comparable<Name> , CharSequence

This class represents anything that can have a "Name". In the simplest case it only represents a local name in a flat hierarchy, such as myVariable. However, it can also be used to represent fully qualified name with a complex name hierarchy, such as my::namespace::function.

Constructors

constructor(localName: String, parent: Name? = null, language: Language<*>?)

constructor(localName: String, parent: Name? = null, delimiter: String = ".")

Types

object Companion

Properties

val delimiter: String

A potential namespace delimiter, usually either . or ::.

isKnownOperatorName

val CharSequence.isKnownOperatorName: Boolean

Checks whether the name for a function (as CharSequence) is a known operator name.

open override val length: Int

val localName: String

The local name (sometimes also called simple name) without any namespace information.

val parent: Name? = null

The parent name, e.g., the namespace this name lives in.

Functions

fun append(s: String): Name

This function appends a string to the local name and returns a new Name.

open override fun clone(): Name

open operator override fun compareTo(other: Name): Int

Compare names according to the string representation of the fullName.

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

fun Name?.fqn(localName: String, delimiter: String = this?.delimiter ?: "."): Name

Returns a new Name based on the localName and the current name as parent.

open operator override fun get(index: Int): Char

open override fun hashCode(): Int

fun isQualified(): Boolean

A name can be considered as "qualified", if it has any specified parent. Otherwise, only the localName is specified and the name is "unqualified".

fun lastPartsMatch(ending: Name): Boolean

fun lastPartsMatch(ending: String): Boolean

Determines if this name ends with the ending (i.e., the localNames match until the ending has no parent anymore).

fun replace(oldValue: String, newValue: String): Name

This functions replaces all occurrences of oldValue with newValue in the local name and returns a new Name.

open override fun subSequence(startIndex: Int, endIndex: Int): CharSequence

open override fun toString(): String

Returns the string representation of this name using a fully qualified name notation with the specified delimiter.