1 /*
   2  * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javafx.beans.property;
  27 
  28 import javafx.collections.ObservableMap;
  29 import static javafx.collections.MapChangeListener.Change;
  30 
  31 /**
  32  * This class provides a convenient class to define read-only properties. It
  33  * creates two properties that are synchronized. One property is read-only
  34  * and can be passed to external users. The other property is read- and
  35  * writable and should be used internally only.
  36  *
  37  * @since JavaFX 2.1
  38  */
  39 public class ReadOnlyMapWrapper<K, V> extends SimpleMapProperty<K, V> {
  40 
  41     private ReadOnlyPropertyImpl readOnlyProperty;
  42 
  43     /**
  44      * The constructor of {@code ReadOnlyMapWrapper}
  45      */
  46     public ReadOnlyMapWrapper() {
  47     }
  48 
  49     /**
  50      * The constructor of {@code ReadOnlyMapWrapper}
  51      *
  52      * @param initialValue
  53      *            the initial value of the wrapped value
  54      */
  55     public ReadOnlyMapWrapper(ObservableMap<K, V> initialValue) {
  56         super(initialValue);
  57     }
  58 
  59     /**
  60      * The constructor of {@code ReadOnlyMapWrapper}
  61      *
  62      * @param bean
  63      *            the bean of this {@code ReadOnlyMapWrapper}
  64      * @param name
  65      *            the name of this {@code ReadOnlyMapWrapper}
  66      */
  67     public ReadOnlyMapWrapper(Object bean, String name) {
  68         super(bean, name);
  69     }
  70 
  71     /**
  72      * The constructor of {@code ReadOnlyMapWrapper}
  73      *
  74      * @param bean
  75      *            the bean of this {@code ReadOnlyMapWrapper}
  76      * @param name
  77      *            the name of this {@code ReadOnlyMapWrapper}
  78      * @param initialValue
  79      *            the initial value of the wrapped value
  80      */
  81     public ReadOnlyMapWrapper(Object bean, String name,
  82                               ObservableMap<K, V> initialValue) {
  83         super(bean, name, initialValue);
  84     }
  85 
  86     /**
  87      * Returns the readonly property, that is synchronized with this
  88      * {@code ReadOnlyMapWrapper}.
  89      *
  90      * @return the readonly property
  91      */
  92     public ReadOnlyMapProperty<K, V> getReadOnlyProperty() {
  93         if (readOnlyProperty == null) {
  94             readOnlyProperty = new ReadOnlyPropertyImpl();
  95         }
  96         return readOnlyProperty;
  97     }
  98 
  99     /**
 100      * {@inheritDoc}
 101      */
 102     @Override
 103     protected void fireValueChangedEvent() {
 104         super.fireValueChangedEvent();
 105         if (readOnlyProperty != null) {
 106             readOnlyProperty.fireValueChangedEvent();
 107         }
 108     }
 109 
 110     /**
 111      * {@inheritDoc}
 112      */
 113     @Override
 114     protected void fireValueChangedEvent(Change<? extends K, ? extends V> change) {
 115         super.fireValueChangedEvent(change);
 116         if (readOnlyProperty != null) {
 117             readOnlyProperty.fireValueChangedEvent(change);
 118         }
 119     }
 120 
 121     private class ReadOnlyPropertyImpl extends ReadOnlyMapPropertyBase<K, V> {
 122 
 123         @Override
 124         public ObservableMap<K, V> get() {
 125             return ReadOnlyMapWrapper.this.get();
 126         }
 127 
 128         @Override
 129         public Object getBean() {
 130             return ReadOnlyMapWrapper.this.getBean();
 131         }
 132 
 133         @Override
 134         public String getName() {
 135             return ReadOnlyMapWrapper.this.getName();
 136         }
 137 
 138         @Override
 139         public ReadOnlyIntegerProperty sizeProperty() {
 140             return ReadOnlyMapWrapper.this.sizeProperty();
 141         }
 142 
 143         @Override
 144         public ReadOnlyBooleanProperty emptyProperty() {
 145             return ReadOnlyMapWrapper.this.emptyProperty();
 146         }
 147     }
 148 }