Source code

001/*
002 * Copyright (c) 2011, 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.property;
027
028import javafx.beans.value.ObservableValue;
029
030/**
031 * Generic interface that defines the methods common to all readable properties
032 * independent of their type.
033 * 
034 * 
035 * @param <T>
036 *            the type of the wrapped value
037 */
038public interface ReadOnlyProperty<T> extends ObservableValue<T> {
039
040    /**
041     * Returns the {@code Object} that contains this property. If this property
042     * is not contained in an {@code Object}, {@code null} is returned.
043     * 
044     * @return the containing {@code Object} or {@code null}
045     */
046    Object getBean();
047
048    /**
049     * Returns the name of this property. If the property does not have a name,
050     * this method returns an empty {@code String}.
051     * 
052     * @return the name or an empty {@code String}
053     */
054    String getName();
055
056}