001/*
002 * ModeShape (http://www.modeshape.org)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *       http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.modeshape.common.annotation;
017
018import static java.lang.annotation.ElementType.CONSTRUCTOR;
019import static java.lang.annotation.ElementType.FIELD;
020import static java.lang.annotation.ElementType.METHOD;
021import static java.lang.annotation.ElementType.PACKAGE;
022import static java.lang.annotation.ElementType.TYPE;
023import static java.lang.annotation.RetentionPolicy.RUNTIME;
024import java.lang.annotation.Documented;
025import java.lang.annotation.Retention;
026import java.lang.annotation.Target;
027
028/**
029 * Annotation that can be used to specify that the target field, method, constructor, package or type is read-only.
030 * 
031 * @see Immutable
032 */
033@Documented
034@Retention( RUNTIME )
035@Target( {FIELD, METHOD, CONSTRUCTOR, PACKAGE, TYPE} )
036public @interface ReadOnly {
037
038}