src/java.base/share/classes/java/util/ConcurrentModificationException.java
author chegar
Thu, 17 Oct 2019 20:54:25 +0100
branchdatagramsocketimpl-branch
changeset 58679 9c3209ff7550
parent 58678 9cf78a70fa4f
parent 58288 48e480e56aad
permissions -rw-r--r--
datagramsocketimpl-branch: merge with default
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
2
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
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
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
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
    23
 * questions.
2
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
6537
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    52
 * throw {@code ConcurrentModificationException} on a best-effort basis.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * Therefore, it would be wrong to write a program that depended on this
6537
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    54
 * exception for its correctness: <i>{@code ConcurrentModificationException}
2
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
18824
9fa4af2af63d 8015320: Pull spliterator() up from Collection to Iterable
henryjen
parents: 7668
diff changeset
    60
 * @see     Spliterator
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 * @see     ListIterator
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
 * @see     Vector
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
 * @see     LinkedList
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
 * @see     HashSet
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 * @see     Hashtable
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
 * @see     TreeMap
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
 * @see     AbstractList
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
 * @since   1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
public class ConcurrentModificationException extends RuntimeException {
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
    71
    @java.io.Serial
1320
2412b1562801 6749308: java.io, java.lang, java.util exception classes don't specify serialVersionUID
chegar
parents: 2
diff changeset
    72
    private static final long serialVersionUID = -3666751008965953603L;
2412b1562801 6749308: java.io, java.lang, java.util exception classes don't specify serialVersionUID
chegar
parents: 2
diff changeset
    73
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * Constructs a ConcurrentModificationException with no
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    public ConcurrentModificationException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    /**
6537
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    82
     * Constructs a {@code ConcurrentModificationException} with the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * specified detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * @param message the detail message pertaining to this exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
    public ConcurrentModificationException(String message) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
        super(message);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
    }
6537
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    90
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    91
    /**
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    92
     * Constructs a new exception with the specified cause and a detail
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    93
     * message of {@code (cause==null ? null : cause.toString())} (which
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    94
     * typically contains the class and detail message of {@code cause}.
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    95
     *
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    96
     * @param  cause the cause (which is saved for later retrieval by the
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    97
     *         {@link Throwable#getCause()} method).  (A {@code null} value is
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    98
     *         permitted, and indicates that the cause is nonexistent or
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
    99
     *         unknown.)
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   100
     * @since  1.7
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   101
     */
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   102
    public ConcurrentModificationException(Throwable cause) {
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   103
        super(cause);
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   104
    }
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   105
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   106
    /**
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   107
     * Constructs a new exception with the specified detail message and
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   108
     * cause.
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   109
     *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 57956
diff changeset
   110
     * <p>Note that the detail message associated with {@code cause} is
6537
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   111
     * <i>not</i> automatically incorporated in this exception's detail
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   112
     * message.
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   113
     *
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   114
     * @param  message the detail message (which is saved for later retrieval
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   115
     *         by the {@link Throwable#getMessage()} method).
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   116
     * @param  cause the cause (which is saved for later retrieval by the
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   117
     *         {@link Throwable#getCause()} method).  (A {@code null} value
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   118
     *         is permitted, and indicates that the cause is nonexistent or
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   119
     *         unknown.)
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   120
     * @since 1.7
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   121
     */
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   122
    public ConcurrentModificationException(String message, Throwable cause) {
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   123
        super(message, cause);
7aa4e7bb5dae 6881498: (file) Re-examine DirectoryStream exception handling
alanb
parents: 5506
diff changeset
   124
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
}