Skip to content

Commit

Permalink
Unmodifiable & UnmodifiableView
Browse files Browse the repository at this point in the history
  • Loading branch information
amaembo committed Jan 24, 2020
1 parent 79be818 commit c7ca7eb
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
33 changes: 33 additions & 0 deletions java8/src/main/java/org/jetbrains/annotations/Unmodifiable.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright 2000-2020 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
*
* http://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;

import java.lang.annotation.*;

/**
* An annotation which marks a {@link java.util.Collection} or {@link java.util.Map} type
* as unmodifiable. A collection or a map is unmodifiable if any mutator methods
* throw exception or have no effect, and the objects stored as collection elements,
* map keys, and map values are never changed.
*
* @see UnmodifiableView
* @since 19.0.0
*/
@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE_USE})
public @interface Unmodifiable {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright 2000-2020 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
*
* http://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;

import java.lang.annotation.*;

/**
* An annotation which marks a {@link java.util.Collection} or {@link java.util.Map} type
* as unmodifiable. A collection or a map is unmodifiable if any mutator methods
* (e.g. {@link java.util.Collection#add(Object)}) throw exception or have no effect.
* However, the content of the collection or the map may still be updated by other code.
*
* @see Unmodifiable
* @since 19.0.0
*/
@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE_USE})
public @interface UnmodifiableView {
}

0 comments on commit c7ca7eb

Please sign in to comment.