src/java.naming/share/classes/javax/naming/event/ObjectChangeListener.java
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 32029 jdk/src/java.naming/share/classes/javax/naming/event/ObjectChangeListener.java@a5538163e144
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1999, 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: 2
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: 2
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: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
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 javax.naming.event;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    29
  * Specifies the method that a listener of a {@code NamingEvent}
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    30
  * with event type of {@code OBJECT_CHANGED} must implement.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
  *<p>
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    32
  * An {@code OBJECT_CHANGED} event type is fired when (the contents of)
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
  * an object has changed. This might mean that its attributes have been modified,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
  * added, or removed, and/or that the object itself has been replaced.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
  * How the object has changed can be determined by examining the
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    36
  * {@code NamingEvent}'s old and new bindings.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
  *<p>
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    38
  * A listener interested in {@code OBJECT_CHANGED} event types must:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
  *<ol>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
  *
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    41
  *<li>Implement this interface and its method ({@code objectChanged()})
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    42
  *<li>Implement {@code NamingListener.namingExceptionThrown()} so that
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
  * it will be notified of exceptions thrown while attempting to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
  * collect information about the events.
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    45
  *<li>Register with the source using the source's {@code addNamingListener()}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
  *    method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
  *</ol>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
  * A listener that wants to be notified of namespace change events
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    49
  * should also implement the {@code NamespaceChangeListener}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
  * interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
  * @author Rosanna Lee
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
  * @author Scott Seligman
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
  * @see NamingEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
  * @see NamespaceChangeListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
  * @see EventContext
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
  * @see EventDirContext
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
  * @since 1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
  */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
public interface ObjectChangeListener extends NamingListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Called when an object has been changed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * The binding of the changed object can be obtained using
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    67
     * {@code evt.getNewBinding()}. Its old binding (before the change)
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    68
     * can be obtained using {@code evt.getOldBinding()}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * @param evt The nonnull naming event.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * @see NamingEvent#OBJECT_CHANGED
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    void objectChanged(NamingEvent evt);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
}