javafx.beans.property.SimpleMapProperty 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.property;
import javafx.collections.ObservableMap;
import javafx.collections.ObservableSet;
/**
* This class provides a full implementation of a {@link Property} wrapping an
* {@code ObservableMap}.
*
* @see MapPropertyBase
*
* @param the type of the key elements of the {@code Map}
* @param the type of the value elements of the {@code Map}
* @since JavaFX 2.1
*/
public class SimpleMapProperty extends MapPropertyBase {
private static final Object DEFAULT_BEAN = null;
private static final String DEFAULT_NAME = "";
private final Object bean;
private final String name;
/**
* {@inheritDoc}
*/
@Override
public Object getBean() {
return bean;
}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return name;
}
/**
* The constructor of {@code SimpleMapProperty}
*/
public SimpleMapProperty() {
this(DEFAULT_BEAN, DEFAULT_NAME);
}
/**
* The constructor of {@code SimpleMapProperty}
*
* @param initialValue
* the initial value of the wrapped value
*/
public SimpleMapProperty(ObservableMap initialValue) {
this(DEFAULT_BEAN, DEFAULT_NAME, initialValue);
}
/**
* The constructor of {@code SimpleMapProperty}
*
* @param bean
* the bean of this {@code MapProperty}
* @param name
* the name of this {@code MapProperty}
*/
public SimpleMapProperty(Object bean, String name) {
this.bean = bean;
this.name = (name == null) ? DEFAULT_NAME : name;
}
/**
* The constructor of {@code SimpleMapProperty}
*
* @param bean
* the bean of this {@code MapProperty}
* @param name
* the name of this {@code MapProperty}
* @param initialValue
* the initial value of the wrapped value
*/
public SimpleMapProperty(Object bean, String name, ObservableMap initialValue) {
super(initialValue);
this.bean = bean;
this.name = (name == null) ? DEFAULT_NAME : name;
}
}