commonMain.org.jetbrains.annotations.Unmodifiable.kt Maven / Gradle / Ivy
/*
* Copyright 2000-2021 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.annotations
/**
* An annotation which marks a [Collection] or [Map] type
* as unmodifiable. A collection or a map is unmodifiable if any mutator methods
* (e.g. [MutableCollection.add]) throw exception or have no effect,
* and the object references stored as collection elements, map keys, and map values
* are never changed. The referenced objects themselves still could be changed if they
* are mutable.
*
* @see UnmodifiableView
*
* @since 19.0.0
*/
@MustBeDocumented
@Retention(AnnotationRetention.BINARY)
@Target(AnnotationTarget.CLASS, AnnotationTarget.TYPE, AnnotationTarget.TYPE_PARAMETER)
annotation class Unmodifiable