jdk/src/share/classes/java/util/ConcurrentModificationException.java
author xdono
Thu, 02 Oct 2008 19:58:32 -0700
changeset 1247 b4c26443dee5
parent 2 90ce3da70b43
child 1320 2412b1562801
permissions -rw-r--r--
6754988: Update copyright year Summary: Update for files that have been modified starting July 2008 Reviewed-by: ohair, tbell
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1997-2006 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.util;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * This exception may be thrown by methods that have detected concurrent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * modification of an object when such modification is not permissible.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * For example, it is not generally permissible for one thread to modify a Collection
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * while another thread is iterating over it.  In general, the results of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * iteration are undefined under these circumstances.  Some Iterator
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * implementations (including those of all the general purpose collection implementations
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * provided by the JRE) may choose to throw this exception if this behavior is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * detected.  Iterators that do this are known as <i>fail-fast</i> iterators,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * as they fail quickly and cleanly, rather that risking arbitrary,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * non-deterministic behavior at an undetermined time in the future.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * Note that this exception does not always indicate that an object has
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * been concurrently modified by a <i>different</i> thread.  If a single
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * thread issues a sequence of method invocations that violates the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * contract of an object, the object may throw this exception.  For
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * example, if a thread modifies a collection directly while it is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * iterating over the collection with a fail-fast iterator, the iterator
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * will throw this exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * <p>Note that fail-fast behavior cannot be guaranteed as it is, generally
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * speaking, impossible to make any hard guarantees in the presence of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * unsynchronized concurrent modification.  Fail-fast operations
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * throw <tt>ConcurrentModificationException</tt> on a best-effort basis.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * Therefore, it would be wrong to write a program that depended on this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * exception for its correctness: <i><tt>ConcurrentModificationException</tt>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * should be used only to detect bugs.</i>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 * @author  Josh Bloch
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * @see     Collection
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 * @see     Iterator
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 * @see     ListIterator
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 * @see     Vector
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
 * @see     LinkedList
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
 * @see     HashSet
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
 * @see     Hashtable
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 * @see     TreeMap
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
 * @see     AbstractList
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
 * @since   1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
public class ConcurrentModificationException extends RuntimeException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * Constructs a ConcurrentModificationException with no
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    public ConcurrentModificationException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * Constructs a <tt>ConcurrentModificationException</tt> with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     * specified detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     * @param message the detail message pertaining to this exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    public ConcurrentModificationException(String message) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
        super(message);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
}