001/*
002 * Copyright 2009-2014 UnboundID Corp.
003 * All Rights Reserved.
004 */
005/*
006 * Copyright (C) 2009-2014 UnboundID Corp.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU General Public License (GPLv2 only)
010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011 * as published by the Free Software Foundation.
012 *
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Public License for more details.
017 *
018 * You should have received a copy of the GNU General Public License
019 * along with this program; if not, see <http://www.gnu.org/licenses>.
020 */
021package com.unboundid.util;
022
023
024
025import java.lang.annotation.Documented;
026import java.lang.annotation.ElementType;
027import java.lang.annotation.Retention;
028import java.lang.annotation.RetentionPolicy;
029import java.lang.annotation.Target;
030
031
032
033/**
034 * This annotation type is used to indicate that instances of the associated
035 * class may be altered after they have been created.
036 * <BR><BR>
037 * It will only be used for classes which are primarily used as data structures
038 * and will not be included in classes whose primary purpose is something other
039 * than as a data type.  It will also not be used for interfaces, abstract
040 * classes, or enums.
041 * <BR><BR>
042 * This annotation type will appear in the generated Javadoc documentation for
043 * classes and interfaces that include it.
044 *
045 * @see  NotMutable
046 */
047@Documented()
048@Retention(RetentionPolicy.RUNTIME)
049@Target({ ElementType.TYPE })
050public @interface Mutable
051{
052}