rt/emul/compact/src/main/java/java/beans/IndexedPropertyChangeEvent.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Tue, 26 Feb 2013 16:54:16 +0100
changeset 772 d382dacfd73f
parent 601 emul/compact/src/main/java/java/beans/IndexedPropertyChangeEvent.java@5198affdb915
permissions -rw-r--r--
Moving modules around so the runtime is under one master pom and can be built without building other modules that are in the repository
jaroslav@601
     1
/*
jaroslav@601
     2
 * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
jaroslav@601
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@601
     4
 *
jaroslav@601
     5
 * This code is free software; you can redistribute it and/or modify it
jaroslav@601
     6
 * under the terms of the GNU General Public License version 2 only, as
jaroslav@601
     7
 * published by the Free Software Foundation.  Oracle designates this
jaroslav@601
     8
 * particular file as subject to the "Classpath" exception as provided
jaroslav@601
     9
 * by Oracle in the LICENSE file that accompanied this code.
jaroslav@601
    10
 *
jaroslav@601
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@601
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@601
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@601
    14
 * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@601
    15
 * accompanied this code).
jaroslav@601
    16
 *
jaroslav@601
    17
 * You should have received a copy of the GNU General Public License version
jaroslav@601
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@601
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@601
    20
 *
jaroslav@601
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@601
    22
 * or visit www.oracle.com if you need additional information or have any
jaroslav@601
    23
 * questions.
jaroslav@601
    24
 */
jaroslav@601
    25
package java.beans;
jaroslav@601
    26
jaroslav@601
    27
/**
jaroslav@601
    28
 * An "IndexedPropertyChange" event gets delivered whenever a component that
jaroslav@601
    29
 * conforms to the JavaBeans&trade; specification (a "bean") changes a bound
jaroslav@601
    30
 * indexed property. This class is an extension of <code>PropertyChangeEvent</code>
jaroslav@601
    31
 * but contains the index of the property that has changed.
jaroslav@601
    32
 * <P>
jaroslav@601
    33
 * Null values may be provided for the old and the new values if their
jaroslav@601
    34
 * true values are not known.
jaroslav@601
    35
 * <P>
jaroslav@601
    36
 * An event source may send a null object as the name to indicate that an
jaroslav@601
    37
 * arbitrary set of if its properties have changed.  In this case the
jaroslav@601
    38
 * old and new values should also be null.
jaroslav@601
    39
 *
jaroslav@601
    40
 * @since 1.5
jaroslav@601
    41
 * @author Mark Davidson
jaroslav@601
    42
 */
jaroslav@601
    43
public class IndexedPropertyChangeEvent extends PropertyChangeEvent {
jaroslav@601
    44
    private static final long serialVersionUID = -320227448495806870L;
jaroslav@601
    45
jaroslav@601
    46
    private int index;
jaroslav@601
    47
jaroslav@601
    48
    /**
jaroslav@601
    49
     * Constructs a new <code>IndexedPropertyChangeEvent</code> object.
jaroslav@601
    50
     *
jaroslav@601
    51
     * @param source  The bean that fired the event.
jaroslav@601
    52
     * @param propertyName  The programmatic name of the property that
jaroslav@601
    53
     *             was changed.
jaroslav@601
    54
     * @param oldValue      The old value of the property.
jaroslav@601
    55
     * @param newValue      The new value of the property.
jaroslav@601
    56
     * @param index index of the property element that was changed.
jaroslav@601
    57
     */
jaroslav@601
    58
    public IndexedPropertyChangeEvent(Object source, String propertyName,
jaroslav@601
    59
                                      Object oldValue, Object newValue,
jaroslav@601
    60
                                      int index) {
jaroslav@601
    61
        super (source, propertyName, oldValue, newValue);
jaroslav@601
    62
        this.index = index;
jaroslav@601
    63
    }
jaroslav@601
    64
jaroslav@601
    65
    /**
jaroslav@601
    66
     * Gets the index of the property that was changed.
jaroslav@601
    67
     *
jaroslav@601
    68
     * @return The index specifying the property element that was
jaroslav@601
    69
     *         changed.
jaroslav@601
    70
     */
jaroslav@601
    71
    public int getIndex() {
jaroslav@601
    72
        return index;
jaroslav@601
    73
    }
jaroslav@601
    74
jaroslav@601
    75
    void appendTo(StringBuilder sb) {
jaroslav@601
    76
        sb.append("; index=").append(getIndex());
jaroslav@601
    77
    }
jaroslav@601
    78
}