Source code

001/*
002 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.beans;
027
028import javafx.beans.value.ObservableValue;
029
030/**
031 * An {@code InvalidationListener} is notified whenever an
032 * {@link Observable} becomes invalid. It can be registered and
033 * unregistered with {@link Observable#addListener(InvalidationListener)}
034 * respectively {@link Observable#removeListener(InvalidationListener)}
035 * <p>
036 * For an in-depth explanation of invalidation events and how they differ from
037 * change events, see the documentation of {@code ObservableValue}.
038 * <p>
039 * The same instance of {@code InvalidationListener} can be registered to listen
040 * to multiple {@code Observables}.
041 *
042 * @see Observable
043 * @see ObservableValue
044 *
045 *
046 */
047public interface InvalidationListener {
048
049    /**
050     * This method needs to be provided by an implementation of
051     * {@code InvalidationListener}. It is called if an {@link Observable}
052     * becomes invalid.
053     * <p>
054     * In general is is considered bad practice to modify the observed value in
055     * this method.
056     *
057     * @param observable
058     *            The {@code Observable} that became invalid
059     */
060    public void invalidated(Observable observable);
061}