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.value;
027
028/**
029 * A writable typed value.
030 * 
031 * @param T
032 *            The type of the wrapped value
033 * 
034 * @see WritableValue
035 * 
036 * 
037 */
038public interface WritableObjectValue<T> extends WritableValue<T> {
039
040    /**
041     * Get the wrapped value. This must be identical to
042     * the value returned from {@link #getValue()}.
043     * <p>
044     * This method exists only to align WritableObjectValue API with
045     * {@link WritableBooleanValue} and subclasses of {@link WritableNumberValue}
046     * @return The current value
047     */
048    T get();
049
050    /**
051     * Set the wrapped value.
052     * Should be equivalent to {@link #setValue(java.lang.Object) }
053     * @see #get() 
054     * 
055     * @param value
056     *            The new value
057     */
058    void set(T value);
059
060}