javafx.beans.value.WritableBooleanValue Maven / Gradle / Ivy
/*
* Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.beans.value;
/**
* A writable boolean value.
*
* @see WritableValue
*
*
* @since JavaFX 2.0
*/
public interface WritableBooleanValue extends WritableValue {
/**
* Get the wrapped value.
* Unlike {@link #getValue()},
* this method returns primitive boolean.
* Needs to be identical to {@link #getValue()}.
*
* @return The current value
*/
boolean get();
/**
* Set the wrapped value.
* Unlike {@link #setValue(java.lang.Boolean) },
* this method uses primitive boolean.
*
* @param value
* The new value
*/
void set(boolean value);
/**
* Set the wrapped value.
*
* Note: this method should accept null without throwing an exception,
* setting "false" instead.
*
* @param value
* The new value
*/
@Override
void setValue(Boolean value);
}