001/*
002 * Copyright 2009-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2009-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.util;
037
038
039
040import java.lang.annotation.Documented;
041import java.lang.annotation.ElementType;
042import java.lang.annotation.Retention;
043import java.lang.annotation.RetentionPolicy;
044import java.lang.annotation.Target;
045
046
047
048/**
049 * This annotation type is used to indicate that instances of the associated
050 * class may not be altered after they have been created.  Note that this may or
051 * may not indicate strict immutability, as some classes marked with this
052 * annotation type may have their internal state altered in some way that is not
053 * externally visible.  In addition, the following caveats must be observed for
054 * classes containing this annotation type, and for all other classes in the
055 * LDAP SDK:
056 * <UL>
057 *   <LI>
058 *     If an array is provided as an argument to a constructor or a method, then
059 *     that array must not be referenced or altered by the caller at any time
060 *     after that point unless it is clearly noted that it is acceptable to do
061 *     so.
062 *     <BR><BR>
063 *   </LI>
064 *
065 *   <LI>
066 *     If an array is returned by a method, then the contents of that array must
067 *     not be altered unless it is clearly noted that it is acceptable to do so.
068 *     <BR><BR>
069 *   </LI>
070 * </UL>
071 * <BR><BR>
072 * It will only be used for classes which are primarily used as data structures
073 * and will not be included in classes whose primary purpose is something other
074 * than as a data type.  It will also not be used for interfaces, abstract
075 * classes, or enums.
076 * <BR><BR>
077 * This annotation type will appear in the generated Javadoc documentation for
078 * classes and interfaces that include it.
079 *
080 * @see  Mutable
081 */
082@Documented()
083@Retention(RetentionPolicy.RUNTIME)
084@Target({ ElementType.TYPE })
085public @interface NotMutable
086{
087}