Skip to content

KaClassTypeRenderingMode

Controls how a class type which involves a type alias is rendered: either as the abbreviation (the type alias application, e.g. foo.bar.StringAlias) or as its expansion (e.g. kotlin.String), optionally with the other one in a comment.

The mode applies both to a type which carries an abbreviation and to an unexpanded type alias application (a class type whose symbol is a KaTypeAliasSymbol). All modes render the same output for any other type.

See also

Entries

ABBREVIATION

Only the abbreviation, e.g. foo.bar.StringAlias.

ABBREVIATION_WITH_EXPANSION_COMMENT

The abbreviation, followed by its expansion in a comment, e.g. foo.bar.StringAlias /* = kotlin.String */.

EXPANSION

Only the expansion, e.g. kotlin.String.

EXPANSION_WITH_ABBREVIATION_COMMENT

The expansion, followed by the abbreviation in a comment, e.g. kotlin.String /* from: foo.bar.StringAlias */.

Companion properties

entries

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

Companion functions

valueOf

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using entries property as a more efficient alternative returning an immutable list of enum entries.

Properties

name

val name: String

ordinal

val ordinal: Int