{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

RestrictTo.Scope

kotlin.Any
   ↳ kotlin.Enum
     ↳ androidx.annotation.RestrictTo.Scope

Summary

Enum Values

GROUP_ID

This enum value is deprecated. Use LIBRARY_GROUP_PREFIX instead.

LIBRARY

Restrict usage to code within the same library (e.g. the same gradle group ID and artifact ID).

LIBRARY_GROUP

Restrict usage to code within the same group of libraries.

LIBRARY_GROUP_PREFIX

Restrict usage to code within packages whose groups share the same library group prefix up to the last ".", so for example libraries foo.bar:lib1 and foo.baz:lib2 share the prefix "foo." and so they can use each other's apis that are restricted to this scope.

SUBCLASSES

Restrict usage to subclasses of the enclosing class.

TESTS

Restrict usage to tests.

Public functions

RestrictTo.Scope
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Cmn
RestrictTo.Scope
valueOf(value: String)

Returns the enum constant of this type with the specified name.

android
Array<RestrictTo.Scope>

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

Cmn
Array<RestrictTo.Scope>

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

android

Public properties

EnumEntries<RestrictTo.Scope>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Cmn
EnumEntries<RestrictTo.Scope>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

android

Enum Values

GROUP_ID

val RestrictTo.Scope.GROUP_IDRestrictTo.Scope

Restrict usage to code within the same group ID (based on gradle group ID). This is an alias for LIBRARY_GROUP_PREFIX.

Use LIBRARY_GROUP_PREFIX instead

LIBRARY

val RestrictTo.Scope.LIBRARYRestrictTo.Scope

Restrict usage to code within the same library (e.g. the same gradle group ID and artifact ID).

LIBRARY_GROUP

val RestrictTo.Scope.LIBRARY_GROUPRestrictTo.Scope

Restrict usage to code within the same group of libraries. This corresponds to the gradle group ID.

LIBRARY_GROUP_PREFIX

val RestrictTo.Scope.LIBRARY_GROUP_PREFIXRestrictTo.Scope

Restrict usage to code within packages whose groups share the same library group prefix up to the last ".", so for example libraries foo.bar:lib1 and foo.baz:lib2 share the prefix "foo." and so they can use each other's apis that are restricted to this scope. Similarly for com.foo.bar:lib1 and com.foo.baz:lib2 where they share "com.foo.". Library com.bar.qux:lib3 however will not be able to use the restricted api because it only shares the prefix "com." and not all the way until the last ".".

SUBCLASSES

val RestrictTo.Scope.SUBCLASSESRestrictTo.Scope

Restrict usage to subclasses of the enclosing class.

Note: This scope should not be used to annotate packages.

TESTS

val RestrictTo.Scope.TESTSRestrictTo.Scope

Restrict usage to tests.

Public functions

valueOf

fun valueOf(value: String): RestrictTo.Scope

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

valueOf

fun valueOf(value: String): RestrictTo.Scope

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

fun values(): Array<RestrictTo.Scope>

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.

values

fun values(): Array<RestrictTo.Scope>

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.

Public properties

entries

val entriesEnumEntries<RestrictTo.Scope>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

entries

val entriesEnumEntries<RestrictTo.Scope>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.