fxmlView(
+ Class viewType) {
+ return new FxmlViewStep<>(viewType);
+ }
+
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/InjectContext.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/InjectContext.java
new file mode 100644
index 000000000..fb1e52262
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/InjectContext.java
@@ -0,0 +1,16 @@
+package de.saxsys.mvvmfx;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ *
+ * @author alexander.casall
+ *
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface InjectContext {
+}
\ No newline at end of file
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/InjectScope.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/InjectScope.java
new file mode 100644
index 000000000..5bec70b34
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/InjectScope.java
@@ -0,0 +1,23 @@
+package de.saxsys.mvvmfx;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ *
+ * @author alexander.casall
+ *
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface InjectScope {
+
+ /**
+ * the id of the scope.
+ * Default is "" which means that the scope is global.
+ */
+ String value() default "";
+
+}
\ No newline at end of file
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/Scope.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/Scope.java
new file mode 100644
index 000000000..bfe7af114
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/Scope.java
@@ -0,0 +1,44 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+package de.saxsys.mvvmfx;
+
+import de.saxsys.mvvmfx.utils.notifications.NotificationObserver;
+
+/**
+ * Scope.
+ *
+ * @author alexander.casall
+ *
+ */
+public interface Scope {
+
+ default void publish(String messageName, Object... payload) {
+ MvvmFX.getNotificationCenter().publish(this, messageName, payload);
+ }
+
+ default void subscribe(String messageName, NotificationObserver observer) {
+ MvvmFX.getNotificationCenter().subscribe(this, messageName, observer);
+ }
+
+ default void unsubscribe(String messageName, NotificationObserver observer) {
+ MvvmFX.getNotificationCenter().unsubscribe(this, messageName, observer);
+ }
+
+ default void unsubscribe(NotificationObserver observer) {
+ MvvmFX.getNotificationCenter().unsubscribe(this, observer);
+ }
+
+}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/ScopeProvider.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/ScopeProvider.java
new file mode 100644
index 000000000..5b0823ea8
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/ScopeProvider.java
@@ -0,0 +1,12 @@
+package de.saxsys.mvvmfx;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface ScopeProvider {
+ Class[] scopes();
+}
\ No newline at end of file
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/ViewModel.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/ViewModel.java
index 885a9eb29..e7fcfbce7 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/ViewModel.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/ViewModel.java
@@ -15,11 +15,10 @@
******************************************************************************/
package de.saxsys.mvvmfx;
-import de.saxsys.mvvmfx.utils.notifications.NotificationTestHelper;
-import javafx.application.Platform;
import de.saxsys.mvvmfx.internal.viewloader.View;
import de.saxsys.mvvmfx.utils.notifications.NotificationCenter;
import de.saxsys.mvvmfx.utils.notifications.NotificationObserver;
+import de.saxsys.mvvmfx.utils.notifications.NotificationTestHelper;
/**
*
@@ -51,7 +50,7 @@ public interface ViewModel {
*
* This notification mechanism uses the {@link NotificationCenter} internally with the difference that messages send
* by this method aren't globally available. Instead they can only be received by this viewModels {@link #subscribe(String, NotificationObserver)}
- * method or when using this viewModel instance as argument to the {@link NotificationCenter#subscribe(ViewModel, String, NotificationObserver)} method.
+ * method or when using this viewModel instance as argument to the {@link NotificationCenter#subscribe(Object, String, NotificationObserver)} method.
*
*
* See {@link NotificationTestHelper} for a utility that's purpose is to simplify unit tests with notifications.
@@ -62,7 +61,7 @@ public interface ViewModel {
* to be send
*/
default void publish(String messageName, Object... payload) {
- MvvmFX.getNotificationCenter().publish(this, messageName, payload);
+ MvvmFX.getNotificationCenter().publish(System.identityHashCode(this), messageName, payload);
}
/**
@@ -75,7 +74,7 @@ default void publish(String messageName, Object... payload) {
* which should execute when the notification occurs
*/
default void subscribe(String messageName, NotificationObserver observer) {
- MvvmFX.getNotificationCenter().subscribe(this, messageName, observer);
+ MvvmFX.getNotificationCenter().subscribe(System.identityHashCode(this), messageName, observer);
}
/**
@@ -87,7 +86,7 @@ default void subscribe(String messageName, NotificationObserver observer) {
* to remove
*/
default void unsubscribe(String messageName, NotificationObserver observer) {
- MvvmFX.getNotificationCenter().unsubscribe(this, messageName, observer);
+ MvvmFX.getNotificationCenter().unsubscribe(System.identityHashCode(this), messageName, observer);
}
/**
@@ -97,6 +96,6 @@ default void unsubscribe(String messageName, NotificationObserver observer) {
* to be removed
*/
default void unsubscribe(NotificationObserver observer) {
- MvvmFX.getNotificationCenter().unsubscribe(this, observer);
+ MvvmFX.getNotificationCenter().unsubscribe(System.identityHashCode(this), observer);
}
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/ContextImpl.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/ContextImpl.java
new file mode 100644
index 000000000..396215a62
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/ContextImpl.java
@@ -0,0 +1,28 @@
+package de.saxsys.mvvmfx.internal;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import de.saxsys.mvvmfx.Context;
+import de.saxsys.mvvmfx.Scope;
+
+public class ContextImpl implements Context {
+
+ private final Map, Object> scopeContext;
+
+ public ContextImpl() {
+ this(new HashMap<>());
+ }
+
+ private ContextImpl(Map, Object> scopeContext) {
+ this.scopeContext = scopeContext;
+ }
+
+ public void addScopeToContext(Scope scope) {
+ scopeContext.put(scope.getClass(), scope);
+ }
+
+ public Object getScope(Class scopeType) {
+ return scopeContext.get(scopeType);
+ }
+}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/MvvmfxApplication.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/MvvmfxApplication.java
index 6c8f760c2..00055123b 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/MvvmfxApplication.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/MvvmfxApplication.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.internal;
import javafx.application.Application;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/WeakValueHashMap.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/WeakValueHashMap.java
new file mode 100644
index 000000000..0e57a41ba
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/WeakValueHashMap.java
@@ -0,0 +1,507 @@
+package de.saxsys.mvvmfx.internal;
+/*
+ * The contents of this file are subject to the terms
+ * of the Common Development and Distribution License
+ * (the "License"). You may not use this file except
+ * in compliance with the License.
+ *
+ * You can obtain a copy of the license at
+ * glassfish/bootstrap/legal/CDDLv1.0.txt or
+ * https://glassfish.dev.java.net/public/CDDLv1.0.html.
+ * See the License for the specific language governing
+ * permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL
+ * HEADER in each file and include the License file at
+ * glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
+ * add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your
+ * own identifying information: Portions Copyright [yyyy]
+ * [name of copyright owner]
+ */
+
+/*
+ * Copyright 2005 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+import java.lang.ref.ReferenceQueue;
+import java.lang.ref.WeakReference;
+import java.util.AbstractCollection;
+import java.util.AbstractSet;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.NoSuchElementException;
+import java.util.Set;
+
+/**
+ * A WeakValueHashMap is implemented as a HashMap that maps keys to WeakValues. Because we don't have access to the
+ * innards of the HashMap, we have to wrap/unwrap value objects with WeakValues on every operation. Fortunately
+ * WeakValues are small, short-lived objects, so the added allocation overhead is tolerable. This implementaton directly
+ * extends java.util.HashMap.
+ *
+ * @author Markus Fuchs
+ * @see java.util.HashMap
+ * @see java.lang.ref.WeakReference
+ */
+
+public class WeakValueHashMap extends HashMap {
+
+ /* Reference queue for cleared WeakValues */
+ private final ReferenceQueue queue = new ReferenceQueue();
+
+ /**
+ * Returns the number of key-value mappings in this map.
+ *
+ *
+ * @return the number of key-value mappings in this map.
+ */
+ @Override
+ public int size() {
+ // delegate to entrySet, as super.size() also counts WeakValues
+ return entrySet().size();
+ }
+
+ /**
+ * Returns true if this map contains no key-value mappings.
+ *
+ *
+ * @return true if this map contains no key-value mappings.
+ */
+ @Override
+ public boolean isEmpty() {
+ return size() == 0;
+ }
+
+ /**
+ * Returns true if this map contains a mapping for the specified key.
+ *
+ *
+ * @param key
+ * key whose presence in this map is to be tested
+ * @return true if this map contains a mapping for the specified key.
+ */
+ @Override
+ public boolean containsKey(Object key) {
+ // need to clean up gc'ed values before invoking super method
+ processQueue();
+ return super.containsKey(key);
+ }
+
+ /**
+ * Returns true if this map maps one or more keys to the specified value.
+ *
+ *
+ * @param value
+ * value whose presence in this map is to be tested
+ * @return true if this map maps one or more keys to this value.
+ */
+ @Override
+ public boolean containsValue(Object value) {
+ return super.containsValue(WeakValue.create(value));
+ }
+
+ /**
+ * Gets the value for the given key.
+ *
+ *
+ * @param key
+ * key whose associated value, if any, is to be returned
+ * @return the value to which this map maps the specified key.
+ */
+ @Override
+ public Object get(Object key) {
+ // We don't need to remove garbage collected values here;
+ // if they are garbage collected, the get() method returns null;
+ // the next put() call with the same key removes the old value
+ // automatically so that it can be completely garbage collected
+ return getReferenceObject((WeakReference) super.get(key));
+ }
+
+ /**
+ * Puts a new (key,value) into the map.
+ *
+ *
+ * @param key
+ * key with which the specified value is to be associated.
+ * @param value
+ * value to be associated with the specified key.
+ * @return previous value associated with specified key, or null if there was no mapping for key or the value has
+ * been garbage collected by the garbage collector.
+ */
+ @Override
+ public Object put(Object key, Object value) {
+ // If the map already contains an equivalent key, the new key
+ // of a (key, value) pair is NOT stored in the map but the new
+ // value only. But as the key is strongly referenced by the
+ // map, it can not be removed from the garbage collector, even
+ // if the key becomes weakly reachable due to the old
+ // value. So, it isn't necessary to remove all garbage
+ // collected values with their keys from the map before the
+ // new entry is made. We only clean up here to distribute
+ // clean up calls on different operations.
+ processQueue();
+
+ WeakValue oldValue = (WeakValue) super.put(key, WeakValue.create(key, value, queue));
+ return getReferenceObject(oldValue);
+ }
+
+ /**
+ * Removes key and value for the given key.
+ *
+ *
+ * @param key
+ * key whose mapping is to be removed from the map.
+ * @return previous value associated with specified key, or null if there was no mapping for key or the value has
+ * been garbage collected by the garbage collector.
+ */
+ @Override
+ public Object remove(Object key) {
+ return getReferenceObject((WeakReference) super.remove(key));
+ }
+
+ /**
+ * A convenience method to return the object held by the weak reference or null if it does not exist.
+ */
+ private final Object getReferenceObject(WeakReference ref) {
+ return (ref == null) ? null : ref.get();
+ }
+
+ /**
+ * Removes all garbage collected values with their keys from the map. Since we don't know how much the
+ * ReferenceQueue.poll() operation costs, we should not call it every map operation.
+ */
+ private void processQueue() {
+ WeakValue wv = null;
+
+ while ((wv = (WeakValue) this.queue.poll()) != null) {
+ // "super" is not really necessary but use it
+ // to be on the safe side
+ super.remove(wv.key);
+ }
+ }
+
+ /* -- Helper classes -- */
+
+ /**
+ * We need this special class to keep the backward reference from the value to the key, so that we are able to
+ * remove the key if the value is garbage collected.
+ */
+ private static class WeakValue extends WeakReference {
+ /**
+ * It's the same as the key in the map. We need the key to remove the value if it is garbage collected.
+ */
+ private Object key;
+
+ private WeakValue(Object value) {
+ super(value);
+ }
+
+ /**
+ * Creates a new weak reference without adding it to a ReferenceQueue.
+ */
+ private static WeakValue create(Object value) {
+ if (value == null)
+ return null;
+ else
+ return new WeakValue(value);
+ }
+
+ private WeakValue(Object key, Object value, ReferenceQueue queue) {
+ super(value, queue);
+ this.key = key;
+ }
+
+ /**
+ * Creates a new weak reference and adds it to the given queue.
+ */
+ private static WeakValue create(Object key, Object value,
+ ReferenceQueue queue) {
+ if (value == null)
+ return null;
+ else
+ return new WeakValue(key, value, queue);
+ }
+
+ /**
+ * A WeakValue is equal to another WeakValue iff they both refer to objects that are, in turn, equal according
+ * to their own equals methods.
+ */
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj)
+ return true;
+
+ if (!(obj instanceof WeakValue))
+ return false;
+
+ Object ref1 = this.get();
+ Object ref2 = ((WeakValue) obj).get();
+
+ if (ref1 == ref2)
+ return true;
+
+ if ((ref1 == null) || (ref2 == null))
+ return false;
+
+ return ref1.equals(ref2);
+ }
+
+ /**
+ *
+ */
+ @Override
+ public int hashCode() {
+ Object ref = this.get();
+
+ return (ref == null) ? 0 : ref.hashCode();
+ }
+ }
+
+ /**
+ * Internal class for entries. This class wraps/unwraps the values of the Entry objects returned from the underlying
+ * map.
+ */
+ private class Entry implements Map.Entry {
+ private final Map.Entry ent;
+ private Object value; /*
+ * Strong reference to value, so that the GC will leave it alone as long as this Entry
+ * exists
+ */
+
+ Entry(Map.Entry ent, Object value) {
+ this.ent = ent;
+ this.value = value;
+ }
+
+ @Override
+ public Object getKey() {
+ return ent.getKey();
+ }
+
+ @Override
+ public Object getValue() {
+ return value;
+ }
+
+ @Override
+ public Object setValue(Object value) {
+ // This call changes the map. Please see the comment on
+ // the put method for the correctness remark.
+ Object oldValue = this.value;
+ this.value = value;
+ ent.setValue(WeakValue.create(getKey(), value, queue));
+ return oldValue;
+ }
+
+ private boolean valEquals(Object o1, Object o2) {
+ return (o1 == null) ? (o2 == null) : o1.equals(o2);
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (!(o instanceof Map.Entry))
+ return false;
+ Map.Entry e = (Map.Entry) o;
+ return (valEquals(ent.getKey(), e.getKey())
+ && valEquals(value, e.getValue()));
+ }
+
+ @Override
+ public int hashCode() {
+ Object k;
+ return ((((k = ent.getKey()) == null) ? 0 : k.hashCode())
+ ^ ((value == null) ? 0 : value.hashCode()));
+ }
+
+ }
+
+ /**
+ * Internal class for entry sets to unwrap/wrap WeakValues stored in the map.
+ */
+ private class EntrySet extends AbstractSet {
+
+ @Override
+ public Iterator iterator() {
+ // remove garbage collected elements
+ processQueue();
+
+ return new Iterator() {
+ Iterator hashIterator = hashEntrySet.iterator();
+ Entry next = null;
+
+ @Override
+ public boolean hasNext() {
+ if (hashIterator.hasNext()) {
+ // since we removed garbage collected elements,
+ // we can simply return the next entry.
+ Map.Entry ent = (Map.Entry) hashIterator.next();
+ WeakValue wv = (WeakValue) ent.getValue();
+ Object v = (wv == null) ? null : wv.get();
+ next = new Entry(ent, v);
+ return true;
+ }
+ return false;
+ }
+
+ @Override
+ public Object next() {
+ if ((next == null) && !hasNext())
+ throw new NoSuchElementException();
+ Entry e = next;
+ next = null;
+ return e;
+ }
+
+ @Override
+ public void remove() {
+ hashIterator.remove();
+ }
+
+ };
+ }
+
+ @Override
+ public boolean isEmpty() {
+ return !(iterator().hasNext());
+ }
+
+ @Override
+ public int size() {
+ int j = 0;
+ for (Iterator i = iterator(); i.hasNext(); i.next())
+ j++;
+ return j;
+ }
+
+ @Override
+ public boolean remove(Object o) {
+ if (!(o instanceof Map.Entry))
+ return false;
+ Map.Entry e = (Map.Entry) o;
+ Object ek = e.getKey();
+ Object ev = e.getValue();
+ Object hv = WeakValueHashMap.this.get(ek);
+ if (hv == null) {
+ // if the map's value is null, we have to check, if the
+ // entry's value is null and the map contains the key
+ if ((ev == null) && WeakValueHashMap.this.containsKey(ek)) {
+ WeakValueHashMap.this.remove(ek);
+ return true;
+ } else {
+ return false;
+ }
+ // otherwise, simply compare the values
+ } else if (hv.equals(ev)) {
+ WeakValueHashMap.this.remove(ek);
+ return true;
+ }
+
+ return false;
+ }
+
+ @Override
+ public int hashCode() {
+ int h = 0;
+ for (Iterator i = hashEntrySet.iterator(); i.hasNext();) {
+ Map.Entry ent = (Map.Entry) i.next();
+ Object k;
+ WeakValue wv = (WeakValue) ent.getValue();
+ if (wv == null)
+ continue;
+ h += ((((k = ent.getKey()) == null) ? 0 : k.hashCode())
+ ^ wv.hashCode());
+ }
+ return h;
+ }
+
+ }
+
+ // internal helper variable, because we can't access
+ // entrySet from the superclass inside the EntrySet class
+ private Set hashEntrySet = null;
+ // stores the EntrySet instance
+ private Set entrySet = null;
+
+ /**
+ * Returns a Set view of the mappings in this map.
+ *
+ *
+ * @return a Set view of the mappings in this map.
+ */
+ @Override
+ public Set entrySet() {
+ if (entrySet == null) {
+ hashEntrySet = super.entrySet();
+ entrySet = new EntrySet();
+ }
+ return entrySet;
+ }
+
+ // stores the value collection
+ private transient Collection values = null;
+
+ /**
+ * Returns a Collection view of the values contained in this map.
+ *
+ *
+ * @return a Collection view of the values contained in this map.
+ */
+ @Override
+ public Collection values() {
+ // delegates to entrySet, because super method returns
+ // WeakValues instead of value objects
+ if (values == null) {
+ values = new AbstractCollection() {
+ @Override
+ public Iterator iterator() {
+ return new Iterator() {
+ private final Iterator i = entrySet().iterator();
+
+ @Override
+ public boolean hasNext() {
+ return i.hasNext();
+ }
+
+ @Override
+ public Object next() {
+ return ((Entry) i.next()).getValue();
+ }
+
+ @Override
+ public void remove() {
+ i.remove();
+ }
+ };
+ }
+
+ @Override
+ public int size() {
+ return WeakValueHashMap.this.size();
+ }
+
+ @Override
+ public boolean contains(Object v) {
+ return WeakValueHashMap.this.containsValue(v);
+ }
+ };
+ }
+ return values;
+ }
+
+}
+
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/DependencyInjector.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/DependencyInjector.java
index c28927626..85fe3438e 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/DependencyInjector.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/DependencyInjector.java
@@ -65,7 +65,7 @@ public void setCustomInjector(Callback, Object> callback) {
* @return
*/
@SuppressWarnings("unchecked")
- T getInstanceOf(Class type) {
+ public T getInstanceOf(Class type) {
if (isCustomInjectorDefined()) {
return (T) customInjector.call(type);
} else {
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/FxmlViewLoader.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/FxmlViewLoader.java
index 37cd80f46..ed8f282d6 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/FxmlViewLoader.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/FxmlViewLoader.java
@@ -15,296 +15,351 @@
******************************************************************************/
package de.saxsys.mvvmfx.internal.viewloader;
+import java.io.IOException;
+import java.net.URL;
+import java.util.Collection;
+import java.util.ResourceBundle;
+import java.util.function.Consumer;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import de.saxsys.mvvmfx.Context;
+import de.saxsys.mvvmfx.Scope;
import de.saxsys.mvvmfx.ViewModel;
import de.saxsys.mvvmfx.ViewTuple;
+import de.saxsys.mvvmfx.internal.ContextImpl;
import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import javafx.util.Callback;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.IOException;
-import java.net.URL;
-import java.util.Optional;
-import java.util.ResourceBundle;
/**
- * This viewLoader is used to load views that are implementing {@link de.saxsys.mvvmfx.FxmlView}.
+ * This viewLoader is used to load views that are implementing
+ * {@link de.saxsys.mvvmfx.FxmlView}.
*
* @author manuel.mauky
*/
public class FxmlViewLoader {
-
- private static final Logger LOG = LoggerFactory.getLogger(FxmlViewLoader.class);
-
- /**
- * Load the viewTuple by it`s ViewType.
- *
- * @param viewType
- * the type of the view to be loaded.
- * @param resourceBundle
- * the resourceBundle that is passed to the {@link javafx.fxml.FXMLLoader}.
- * @param codeBehind
- * the controller instance that is passed to the {@link javafx.fxml.FXMLLoader}
- * @param root
- * the root object that is passed to the {@link javafx.fxml.FXMLLoader}
- * @param viewModel
- * the viewModel instance that is used when loading the viewTuple.
- *
- * @param
- * the generic type of the view.
- * @param
- * the generic type of the viewModel.
- *
- * @return the loaded ViewTuple.
- */
- public , ViewModelType extends ViewModel> ViewTuple loadFxmlViewTuple(
- Class viewType, ResourceBundle resourceBundle, ViewType codeBehind, Object root,
- ViewModelType viewModel) {
- final String pathToFXML = createFxmlPath(viewType);
- return loadFxmlViewTuple(pathToFXML, resourceBundle, codeBehind, root, viewModel);
- }
-
- /**
- * This method is used to create a String with the path to the FXML file for a given View class.
- *
- * This is done by taking the package of the view class (if any) and replace "." with "/". After that the Name of
- * the class and the file ending ".fxml" is appended.
- *
- * Example: de.saxsys.myapp.ui.MainView as view class will be transformed to "/de/saxsys/myapp/ui/MainView.fxml"
- *
- * Example 2: MainView (located in the default package) will be transformed to "/MainView.fxml"
- *
- * @param viewType
- * the view class type.
- * @return the path to the fxml file as string.
- */
- private String createFxmlPath(Class viewType) {
- final StringBuilder pathBuilder = new StringBuilder();
-
- pathBuilder.append("/");
-
- if (viewType.getPackage() != null) {
- pathBuilder.append(viewType.getPackage().getName().replaceAll("\\.", "/"));
- pathBuilder.append("/");
- }
-
- pathBuilder.append(viewType.getSimpleName());
- pathBuilder.append(".fxml");
-
- return pathBuilder.toString();
- }
-
- /**
- * Load the viewTuple by the path of the fxml file.
- *
- * @param resource
- * the string path to the fxml file that is loaded.
- *
- * @param resourceBundle
- * the resourceBundle that is passed to the {@link javafx.fxml.FXMLLoader}.
- * @param codeBehind
- * the controller instance that is passed to the {@link javafx.fxml.FXMLLoader}
- * @param root
- * the root object that is passed to the {@link javafx.fxml.FXMLLoader}
- * @param viewModel
- * the viewModel instance that is used when loading the viewTuple.
- *
- * @param
- * the generic type of the view.
- * @param
- * the generic type of the viewModel.
- *
- * @return the loaded ViewTuple.
- */
- public , ViewModelType extends ViewModel> ViewTuple loadFxmlViewTuple(
- final String resource, ResourceBundle resourceBundle, final ViewType codeBehind, final Object root,
- ViewModelType viewModel) {
- try {
-
- final FXMLLoader loader = createFxmlLoader(resource, resourceBundle, codeBehind, root, viewModel);
-
- loader.load();
-
- final ViewType loadedController = loader.getController();
- final Parent loadedRoot = loader.getRoot();
-
- if (loadedController == null) {
- throw new IOException("Could not load the controller for the View " + resource
- + " maybe your missed the fx:controller in your fxml?");
- }
-
-
- // the actually used ViewModel instance. We need this so we can return it in the ViewTuple
- ViewModelType actualViewModel;
-
- // if no existing viewModel was provided...
- if(viewModel == null) {
- // ... we try to find the created ViewModel from the codeBehind.
- // this is only possible when the codeBehind has a field for the VM and the VM was injected
- actualViewModel = ViewLoaderReflectionUtils.getExistingViewModel(loadedController);
-
- // otherwise we create a new ViewModel. This is needed because the ViewTuple has to contain a VM even if the codeBehind doesn't need one
- if (actualViewModel == null) {
- actualViewModel = ViewLoaderReflectionUtils.createViewModel(loadedController);
- }
- } else {
- actualViewModel = viewModel;
- }
-
-
- return new ViewTuple<>(loadedController, loadedRoot, actualViewModel);
-
- } catch (final IOException ex) {
- throw new RuntimeException(ex);
- }
- }
-
-
- private FXMLLoader createFxmlLoader(String resource, ResourceBundle resourceBundle, View codeBehind, Object root,
- ViewModel viewModel)
- throws IOException {
-
- // Load FXML file
- final URL location = FxmlViewLoader.class.getResource(resource);
- if (location == null) {
- throw new IOException("Error loading FXML - can't load from given resourcepath: " + resource);
- }
-
- final FXMLLoader fxmlLoader = new FXMLLoader();
-
- fxmlLoader.setRoot(root);
- fxmlLoader.setResources(resourceBundle);
- fxmlLoader.setLocation(location);
-
- // when the user provides a viewModel but no codeBehind, we need to use the custom controller factory.
- // in all other cases the default factory can be used.
- if (viewModel != null && codeBehind == null) {
- fxmlLoader.setControllerFactory(new ControllerFactoryForCustomViewModel(viewModel, resourceBundle));
- } else {
- fxmlLoader.setControllerFactory(new DefaultControllerFactory(resourceBundle));
- }
-
- // When the user provides a codeBehind instance we take care of the injection of the viewModel to this
- // controller here.
- if (codeBehind != null) {
- fxmlLoader.setController(codeBehind);
-
- if (viewModel == null) {
- handleInjection(codeBehind, resourceBundle);
- } else {
- handleInjection(codeBehind, resourceBundle, viewModel);
- }
- }
-
- return fxmlLoader;
- }
-
- /**
- * This controller factory will try to create and inject a viewModel instance to every requested controller that is
- * a view.
- */
- private static class DefaultControllerFactory implements Callback, Object> {
- private final ResourceBundle resourceBundle;
-
- public DefaultControllerFactory(ResourceBundle resourceBundle) {
- this.resourceBundle = resourceBundle;
- }
-
- @Override
- public Object call(Class type) {
- Object controller = DependencyInjector.getInstance().getInstanceOf(type);
-
- if (controller instanceof View) {
- View codeBehind = (View) controller;
-
- handleInjection(codeBehind, resourceBundle);
- }
-
- return controller;
- }
- }
-
-
- private static void handleInjection(View codeBehind, ResourceBundle resourceBundle) {
- ResourceBundleInjector.injectResourceBundle(codeBehind, resourceBundle);
-
- final Optional viewModelOptional = ViewLoaderReflectionUtils.createAndInjectViewModel(codeBehind);
-
- if (viewModelOptional.isPresent()) {
- final Object viewModel = viewModelOptional.get();
- if (viewModel instanceof ViewModel) {
- ResourceBundleInjector.injectResourceBundle(viewModel, resourceBundle);
- ViewLoaderReflectionUtils.initializeViewModel((ViewModel) viewModel);
- }
- }
- }
-
- private static void handleInjection(View codeBehind, ResourceBundle resourceBundle, ViewModel viewModel) {
- ResourceBundleInjector.injectResourceBundle(codeBehind, resourceBundle);
-
- if (viewModel != null) {
- ResourceBundleInjector.injectResourceBundle(viewModel, resourceBundle);
-
- ViewLoaderReflectionUtils.injectViewModel(codeBehind, viewModel);
- }
- }
-
- /**
- * A controller factory that is used for the special case where the user provides an existing viewModel to be used
- * while loading.
- *
- * This factory will use this existing viewModel instance for injection of the first view that is
- * requested from this factory. For all later requests this factory will work the same way as the default factory
- * {@link de.saxsys.mvvmfx.internal.viewloader.FxmlViewLoader.DefaultControllerFactory}.
- *
- * The problem we are facing here is the following: The user wants to load a specific View with a specific ViewModel
- * instance. But this root View (fxml file) can declare other sub views. Only the root View has to get the existing
- * ViewModel instance, all other sub Views have to get their ViewModels via the default way (i.e.
- * DependencyInjection or a new instance every time).
- *
- * But, from the perspective of the controller factory, when a View instance is requested, we can't know if this is
- * the root View or a sub View. How do we know when to use the existing ViewModel instance?
- *
- * To fix this we depend on the standard JavaFX behaviour of the {@link FXMLLoader}: The first instance that the
- * FXMLLoader will request from the controller factory will always be the controller for the root fxml file. In this
- * case we can use the existing ViewModel. All subsequent requests will be handled with the default behaviour.
- */
- private static class ControllerFactoryForCustomViewModel implements Callback, Object> {
-
- private boolean customViewModelInjected = false;
-
- private final ViewModel customViewModel;
-
- private final ResourceBundle resourceBundle;
-
- public ControllerFactoryForCustomViewModel(ViewModel customViewModel, ResourceBundle resourceBundle) {
- this.customViewModel = customViewModel;
- this.resourceBundle = resourceBundle;
- }
-
- @Override
- public Object call(Class type) {
- Object controller = DependencyInjector.getInstance().getInstanceOf(type);
-
- if (controller instanceof View) {
- View codeBehind = (View) controller;
-
- if (!customViewModelInjected) {
- ResourceBundleInjector.injectResourceBundle(customViewModel, resourceBundle);
- ResourceBundleInjector.injectResourceBundle(codeBehind, resourceBundle);
-
- ViewLoaderReflectionUtils.injectViewModel(codeBehind, customViewModel);
-
-
- customViewModelInjected = true;
- return codeBehind;
- }
-
- handleInjection(codeBehind, resourceBundle);
- }
-
- return controller;
- }
- }
+
+ private static final Logger LOG = LoggerFactory.getLogger(FxmlViewLoader.class);
+
+ /**
+ * Load the viewTuple by it`s ViewType.
+ *
+ * @param viewType
+ * the type of the view to be loaded.
+ * @param resourceBundle
+ * the resourceBundle that is passed to the
+ * {@link javafx.fxml.FXMLLoader}.
+ * @param codeBehind
+ * the controller instance that is passed to the
+ * {@link javafx.fxml.FXMLLoader}
+ * @param root
+ * the root object that is passed to the
+ * {@link javafx.fxml.FXMLLoader}
+ * @param viewModel
+ * the viewModel instance that is used when loading the
+ * viewTuple.
+ * @param
+ * the generic type of the view.
+ * @param
+ * the generic type of the viewModel.
+ * @return the loaded ViewTuple.
+ */
+ public , ViewModelType extends ViewModel> ViewTuple loadFxmlViewTuple(
+ Class viewType, ResourceBundle resourceBundle, ViewType codeBehind, Object root,
+ ViewModelType viewModel, Context context, Collection providedScopes) {
+
+ final String pathToFXML = createFxmlPath(viewType);
+ return loadFxmlViewTuple(pathToFXML, resourceBundle, codeBehind, root, viewModel, context, providedScopes);
+ }
+
+ /**
+ * This method is used to create a String with the path to the FXML file for
+ * a given View class.
+ *
+ * This is done by taking the package of the view class (if any) and replace
+ * "." with "/". After that the Name of the class and the file ending
+ * ".fxml" is appended.
+ *
+ * Example: de.saxsys.myapp.ui.MainView as view class will be transformed to
+ * "/de/saxsys/myapp/ui/MainView.fxml"
+ *
+ * Example 2: MainView (located in the default package) will be transformed
+ * to "/MainView.fxml"
+ *
+ * @param viewType
+ * the view class type.
+ * @return the path to the fxml file as string.
+ */
+ private String createFxmlPath(Class viewType) {
+ final StringBuilder pathBuilder = new StringBuilder();
+
+ pathBuilder.append("/");
+
+ if (viewType.getPackage() != null) {
+ pathBuilder.append(viewType.getPackage().getName().replaceAll("\\.", "/"));
+ pathBuilder.append("/");
+ }
+
+ pathBuilder.append(viewType.getSimpleName());
+ pathBuilder.append(".fxml");
+
+ return pathBuilder.toString();
+ }
+
+ /**
+ * Load the viewTuple by the path of the fxml file.
+ *
+ * @param resource
+ * the string path to the fxml file that is loaded.
+ * @param resourceBundle
+ * the resourceBundle that is passed to the
+ * {@link javafx.fxml.FXMLLoader}.
+ * @param codeBehind
+ * the controller instance that is passed to the
+ * {@link javafx.fxml.FXMLLoader}
+ * @param root
+ * the root object that is passed to the
+ * {@link javafx.fxml.FXMLLoader}
+ * @param viewModel
+ * the viewModel instance that is used when loading the
+ * viewTuple.
+ * @param
+ * the generic type of the view.
+ * @param
+ * the generic type of the viewModel.
+ * @return the loaded ViewTuple.
+ */
+ public , ViewModelType extends ViewModel> ViewTuple loadFxmlViewTuple(
+ final String resource, ResourceBundle resourceBundle, final ViewType codeBehind, final Object root,
+ ViewModelType viewModel, Context parentContext, Collection providedScopes) {
+ try {
+
+ // FIXME Woanders hin?
+ ContextImpl context = ViewLoaderScopeUtils.prepareContext(parentContext, providedScopes);
+ //////////////////////////////////////////////////////////////////////
+
+ final FXMLLoader loader = createFxmlLoader(resource, resourceBundle, codeBehind, root, viewModel, context);
+
+ loader.load();
+
+ final ViewType loadedController = loader.getController();
+ final Parent loadedRoot = loader.getRoot();
+
+ if (loadedController == null) {
+ throw new IOException("Could not load the controller for the View " + resource
+ + " maybe your missed the fx:controller in your fxml?");
+ }
+
+ // the actually used ViewModel instance. We need this so we can
+ // return it in the ViewTuple
+ ViewModelType actualViewModel;
+
+ // FIXME CONTEXT
+
+ // if no existing viewModel was provided...
+ if (viewModel == null) {
+ // ... we try to find the created ViewModel from the codeBehind.
+ // this is only possible when the codeBehind has a field for the
+ // VM and the VM was injected
+ actualViewModel = ViewLoaderReflectionUtils.getExistingViewModel(loadedController);
+
+ // otherwise we create a new ViewModel. This is needed because
+ // the ViewTuple has to contain a VM even if
+ // the codeBehind doesn't need one
+ if (actualViewModel == null) {
+ actualViewModel = ViewLoaderReflectionUtils.createViewModel(loadedController);
+
+ // it is possible that no viewModel could be created (f.e.
+ // when no generic VM type was specified)
+ // otherwise we need to initialize the created ViewModel
+ // instance.
+ if (actualViewModel != null) {
+ ViewLoaderReflectionUtils.initializeViewModel(actualViewModel);
+ }
+ }
+ } else {
+ actualViewModel = viewModel;
+ ViewLoaderReflectionUtils.createAndInjectScopes(actualViewModel, context);
+ }
+ if (actualViewModel != null) {
+ // TODO: Create Testcase for this corner case:
+ // If this view is the root view (the one that is loaded with
+ // the FluentViewLoader)
+ // but in the view there is no injection of the ViewModel
+ // only in this case the scope has to be injected here,
+ // If the viewModel was already injected in the View, it has
+ // it's scopes already injected
+ // ViewLoaderReflectionUtils.createAndInjectScopes(actualViewModel,
+ // context);
+ }
+
+ return new ViewTuple<>(loadedController, loadedRoot, actualViewModel);
+
+ } catch (final IOException ex) {
+ throw new RuntimeException(ex);
+ }
+ }
+
+ private FXMLLoader createFxmlLoader(String resource, ResourceBundle resourceBundle, View codeBehind, Object root,
+ ViewModel viewModel, ContextImpl context) throws IOException {
+ // Load FXML file
+ final URL location = FxmlViewLoader.class.getResource(resource);
+ if (location == null) {
+ throw new IOException("Error loading FXML - can't load from given resourcepath: " + resource);
+ }
+
+ final FXMLLoader fxmlLoader = new FXMLLoader();
+
+ fxmlLoader.setRoot(root);
+ fxmlLoader.setResources(resourceBundle);
+ fxmlLoader.setLocation(location);
+
+ // when the user provides a viewModel but no codeBehind, we need to use
+ // the custom controller factory.
+ // in all other cases the default factory can be used.
+ if (viewModel != null && codeBehind == null) {
+ fxmlLoader
+ .setControllerFactory(new ControllerFactoryForCustomViewModel(viewModel, resourceBundle, context));
+ } else {
+ fxmlLoader.setControllerFactory(new DefaultControllerFactory(resourceBundle, context));
+ }
+
+ // When the user provides a codeBehind instance we take care of the
+ // injection of the viewModel to this
+ // controller here.
+ if (codeBehind != null) {
+ fxmlLoader.setController(codeBehind);
+
+ if (viewModel == null) {
+ handleInjection(codeBehind, resourceBundle, context);
+ } else {
+ handleInjection(codeBehind, resourceBundle, viewModel, context);
+ }
+ }
+
+ return fxmlLoader;
+ }
+
+ /**
+ * This controller factory will try to create and inject a viewModel
+ * instance to every requested controller that is a view.
+ */
+ private static class DefaultControllerFactory implements Callback, Object> {
+ private final ResourceBundle resourceBundle;
+ private final ContextImpl context;
+
+ public DefaultControllerFactory(ResourceBundle resourceBundle, ContextImpl context) {
+ this.resourceBundle = resourceBundle;
+ this.context = context;
+ }
+
+ @Override
+ public Object call(Class type) {
+ Object controller = DependencyInjector.getInstance().getInstanceOf(type);
+
+ if (controller instanceof View) {
+ View codeBehind = (View) controller;
+
+ handleInjection(codeBehind, resourceBundle, context);
+ }
+
+ return controller;
+ }
+ }
+
+ private static void handleInjection(View codeBehind, ResourceBundle resourceBundle, ContextImpl context) {
+ ResourceBundleInjector.injectResourceBundle(codeBehind, resourceBundle);
+
+ Consumer newVmConsumer = viewModel -> {
+ ResourceBundleInjector.injectResourceBundle(viewModel, resourceBundle);
+ ViewLoaderReflectionUtils.createAndInjectScopes(viewModel, context);
+ ViewLoaderReflectionUtils.initializeViewModel(viewModel);
+ };
+
+ ViewLoaderReflectionUtils.createAndInjectViewModel(codeBehind, newVmConsumer);
+ ViewLoaderReflectionUtils.injectContext(codeBehind, context);
+ }
+
+ private static void handleInjection(View codeBehind, ResourceBundle resourceBundle, ViewModel viewModel,
+ ContextImpl context) {
+ ResourceBundleInjector.injectResourceBundle(codeBehind, resourceBundle);
+
+ if (viewModel != null) {
+ ResourceBundleInjector.injectResourceBundle(viewModel, resourceBundle);
+ ViewLoaderReflectionUtils.createAndInjectScopes(viewModel, context);
+ ViewLoaderReflectionUtils.injectViewModel(codeBehind, viewModel);
+ ViewLoaderReflectionUtils.injectContext(codeBehind, context);
+ }
+ }
+
+ /**
+ * A controller factory that is used for the special case where the user
+ * provides an existing viewModel to be used while loading.
+ *
+ * This factory will use this existing viewModel instance for injection of
+ * the first view that is requested from this factory. For
+ * all later requests this factory will work the same way as the default
+ * factory
+ * {@link de.saxsys.mvvmfx.internal.viewloader.FxmlViewLoader.DefaultControllerFactory}
+ * .
+ *
+ * The problem we are facing here is the following: The user wants to load a
+ * specific View with a specific ViewModel instance. But this root View
+ * (fxml file) can declare other sub views. Only the root View has to get
+ * the existing ViewModel instance, all other sub Views have to get their
+ * ViewModels via the default way (i.e. DependencyInjection or a new
+ * instance every time).
+ *
+ * But, from the perspective of the controller factory, when a View instance
+ * is requested, we can't know if this is the root View or a sub View. How
+ * do we know when to use the existing ViewModel instance?
+ *
+ * To fix this we depend on the standard JavaFX behaviour of the
+ * {@link FXMLLoader}: The first instance that the FXMLLoader will request
+ * from the controller factory will always be the controller for the root
+ * fxml file. In this case we can use the existing ViewModel. All subsequent
+ * requests will be handled with the default behaviour.
+ */
+ private static class ControllerFactoryForCustomViewModel implements Callback, Object> {
+
+ private boolean customViewModelInjected = false;
+
+ private final ViewModel customViewModel;
+
+ private final ResourceBundle resourceBundle;
+
+ private final ContextImpl context;
+
+ public ControllerFactoryForCustomViewModel(ViewModel customViewModel, ResourceBundle resourceBundle,
+ ContextImpl context) {
+ this.customViewModel = customViewModel;
+ this.resourceBundle = resourceBundle;
+ this.context = context;
+ }
+
+ @Override
+ public Object call(Class type) {
+ Object controller = DependencyInjector.getInstance().getInstanceOf(type);
+
+ if (controller instanceof View) {
+ View codeBehind = (View) controller;
+
+ if (!customViewModelInjected) {
+ ResourceBundleInjector.injectResourceBundle(customViewModel, resourceBundle);
+ ResourceBundleInjector.injectResourceBundle(codeBehind, resourceBundle);
+
+ ViewLoaderReflectionUtils.injectViewModel(codeBehind, customViewModel);
+
+ customViewModelInjected = true;
+ return codeBehind;
+ }
+
+ handleInjection(codeBehind, resourceBundle, context);
+ }
+
+ return controller;
+ }
+ }
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/JavaViewLoader.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/JavaViewLoader.java
index d31cad1ec..7ab26f884 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/JavaViewLoader.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/JavaViewLoader.java
@@ -15,84 +15,97 @@
******************************************************************************/
package de.saxsys.mvvmfx.internal.viewloader;
-import de.saxsys.mvvmfx.ViewModel;
-import de.saxsys.mvvmfx.ViewTuple;
-import javafx.fxml.Initializable;
-import javafx.scene.Parent;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.security.AccessController;
import java.security.PrivilegedAction;
+import java.util.Collection;
import java.util.List;
import java.util.ResourceBundle;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import de.saxsys.mvvmfx.Context;
+import de.saxsys.mvvmfx.Scope;
+import de.saxsys.mvvmfx.ViewModel;
+import de.saxsys.mvvmfx.ViewTuple;
+import de.saxsys.mvvmfx.internal.ContextImpl;
+import javafx.fxml.Initializable;
+import javafx.scene.Parent;
+
/**
- * This viewLoader is used to load views that are implementing {@link de.saxsys.mvvmfx.JavaView}.
+ * This viewLoader is used to load views that are implementing
+ * {@link de.saxsys.mvvmfx.JavaView}.
*
* @author manuel.mauky
*/
public class JavaViewLoader {
- private static final Logger LOG = LoggerFactory.getLogger(JavaViewLoader.class);
-
-
- private static final String NAMING_CONVENTION_RESOURCES_IDENTIFIER = "resources";
- private static final String NAMING_CONVENTION_INITIALIZE_IDENTIFIER = "initialize";
-
- /**
- * Loads the java written view of the given type and injects the ViewModel for this view.
- * If the given view type implements the {@link javafx.fxml.Initializable} interface the "initialize" method of this
- * interface will be invoked. When this is not the case an implicit initialization will be done that is working
- * similar to the way the {@link javafx.fxml.FXMLLoader} is working.
- * When there is a public no-args method named "initialize" is available this method will be
- * called. When there is a public field of type {@link java.util.ResourceBundle} named "resources"
- * is available this field will get the provided ResourceBundle injected.
- * The "initialize" method (whether from the {@link javafx.fxml.Initializable} interface or implicit) will be
- * invoked after the viewModel was injected. This way the user can create bindings to the viewModel
- * in the initialize method.
- *
- * @param viewType
- * class of the view.
- * @param resourceBundle
- * optional ResourceBundle that will be injected into the view.
- * @param existingViewModel
- * the viewModel instance that is used to load the view.
- * @param
- * the generic type of the view.
- * @param
- * the generic type of the viewModel.
- *
- * @return a fully loaded and initialized instance of the view.
- */
- public , ViewModelType extends ViewModel> ViewTuple loadJavaViewTuple(
- Class
- viewType, ResourceBundle resourceBundle, final ViewModelType existingViewModel) {
- DependencyInjector injectionFacade = DependencyInjector.getInstance();
-
- final ViewType view = injectionFacade.getInstanceOf(viewType);
-
- if (!(view instanceof Parent)) {
- throw new IllegalArgumentException("Can not load java view! The view class has to extend from "
- + Parent.class.getName() + " or one of it's subclasses");
- }
+ private static final Logger LOG = LoggerFactory.getLogger(JavaViewLoader.class);
+ private static final String NAMING_CONVENTION_RESOURCES_IDENTIFIER = "resources";
+ private static final String NAMING_CONVENTION_INITIALIZE_IDENTIFIER = "initialize";
- ViewModelType viewModel = null;
+ /**
+ * Loads the java written view of the given type and injects the ViewModel
+ * for this view.
+ * If the given view type implements the {@link javafx.fxml.Initializable}
+ * interface the "initialize" method of this interface will be invoked. When
+ * this is not the case an implicit initialization will be done that is
+ * working similar to the way the {@link javafx.fxml.FXMLLoader} is working.
+ *
+ * When there is a public no-args method named "initialize"
+ * is available this method will be called. When there is a
+ * public field of type {@link java.util.ResourceBundle}
+ * named "resources" is available this field will get the provided
+ * ResourceBundle injected.
+ * The "initialize" method (whether from the
+ * {@link javafx.fxml.Initializable} interface or implicit) will be invoked
+ * after the viewModel was injected. This way the user can
+ * create bindings to the viewModel in the initialize method.
+ *
+ * @param viewType
+ * class of the view.
+ * @param resourceBundle
+ * optional ResourceBundle that will be injected into the view.
+ * @param existingViewModel
+ * the viewModel instance that is used to load the view.
+ * @param
+ * the generic type of the view.
+ * @param
+ * the generic type of the viewModel.
+ *
+ * @return a fully loaded and initialized instance of the view.
+ */
+ public , ViewModelType extends ViewModel> ViewTuple loadJavaViewTuple(
+ Class viewType, ResourceBundle resourceBundle, final ViewModelType existingViewModel,
+ ViewType codeBehind, Context parentContext, Collection providedScopes) {
+
+ // FIXME Woanders hin?!
+ ContextImpl context = ViewLoaderScopeUtils.prepareContext(parentContext, providedScopes);
+ ////////////////////////////
+
+ DependencyInjector injectionFacade = DependencyInjector.getInstance();
+
+ final ViewType view = codeBehind == null ? injectionFacade.getInstanceOf(viewType) : codeBehind;
+
+ if (!(view instanceof Parent)) {
+ throw new IllegalArgumentException("Can not load java view! The view class has to extend from "
+ + Parent.class.getName() + " or one of it's subclasses");
+ }
+ ViewModelType viewModel = null;
// when no viewmodel was provided by the user...
- if (existingViewModel == null) {
+ if (existingViewModel == null) {
// ... we create a new one (if possible)
viewModel = ViewLoaderReflectionUtils.createViewModel(view);
- } else {
+ } else {
viewModel = existingViewModel;
}
-
- ResourceBundleInjector.injectResourceBundle(view, resourceBundle);
+ ResourceBundleInjector.injectResourceBundle(view, resourceBundle);
// if no ViewModel is available...
if (viewModel == null) {
@@ -100,107 +113,120 @@ public , ViewModelType extends Vi
final List viewModelFields = ViewLoaderReflectionUtils.getViewModelFields(viewType);
- if(!viewModelFields.isEmpty()) {
- throw new RuntimeException("The given view of type <" + view.getClass() + "> has no generic viewModel type declared but tries to inject a viewModel.");
+ if (!viewModelFields.isEmpty()) {
+ throw new RuntimeException("The given view of type <" + view.getClass()
+ + "> has no generic viewModel type declared but tries to inject a viewModel.");
}
-
} else {
ResourceBundleInjector.injectResourceBundle(viewModel, resourceBundle);
- ViewLoaderReflectionUtils.initializeViewModel(viewModel);
+
+ // if the user has provided an existing ViewModel, we will not
+ // (re-)initialize this existing instance
+ ViewLoaderReflectionUtils.createAndInjectScopes(viewModel, context);
+ if (existingViewModel == null) {
+ ViewLoaderReflectionUtils.initializeViewModel(viewModel);
+ }
+
ViewLoaderReflectionUtils.injectViewModel(view, viewModel);
}
-
if (view instanceof Initializable) {
- Initializable initializable = (Initializable) view;
- initializable.initialize(null, resourceBundle);
- } else {
- injectResourceBundle(view, resourceBundle);
- callInitialize(view);
- }
-
- return new ViewTuple<>(view, (Parent) view, viewModel);
- }
-
- /**
- * This method is trying to invoke the initialize method of the given view by reflection. This is done to meet the
- * conventions of the {@link javafx.fxml.FXMLLoader}. The conventions say that when there is a
- * public no-args method with the simple name "initialize" and the class does not implement the
- * {@link javafx.fxml.Initializable} interface, the initialize method will be invoked.
- * This method is package scoped for better testability.
- *
- * @param view
- * the view instance of which the initialize method will be invoked.
- * @param
- * the generic type of the view.
- */
- void callInitialize(View view) {
- try {
- final Method initializeMethod = view.getClass().getMethod(NAMING_CONVENTION_INITIALIZE_IDENTIFIER);
-
- AccessController.doPrivileged((PrivilegedAction) () -> {
- try {
- return initializeMethod.invoke(view);
- } catch (InvocationTargetException e) {
- LOG.warn("The '{}' method of the view {} has thrown an exception!",
- NAMING_CONVENTION_INITIALIZE_IDENTIFIER, view);
-
- Throwable cause = e.getCause();
- if (cause instanceof RuntimeException) {
- throw (RuntimeException) cause;
- } else {
- throw new RuntimeException(cause);
- }
- } catch (IllegalAccessException e) {
- LOG.warn("Can't invoke the '{}' method of the view {} because it is not accessible",
- NAMING_CONVENTION_INITIALIZE_IDENTIFIER, view);
- }
- return null;
- });
-
- } catch (NoSuchMethodException e) {
- // This exception means that there is no initialize method declared.
- // While it's possible that the user has no such method by design,
- // normally and in most cases you need an initialize method in your view (either with Initialize interface
- // or implicit).
- // So it's likely that the user has misspelled the method name or uses a wrong naming convention.
- // For this reason we give the user the log message.
- LOG.debug("There is no '{}' method declared at the view {}", NAMING_CONVENTION_INITIALIZE_IDENTIFIER, view);
- }
- }
-
- /**
- * Injects the given ResourceBundle into the given view using reflection. This is done to meet the conventions of
- * the {@link javafx.fxml.FXMLLoader}. The resourceBundle is only injected when there is a public
- * field of the type {@link java.util.ResourceBundle} named "resources".
- * This method is package scoped for better testability.
- *
- * @param view
- * the view instance that gets the resourceBundle injected.
- * @param resourceBundle
- * the resourceBundle instance that will be injected.
- * @param
- * the generic type of the view.
- */
- void injectResourceBundle(View view,
- ResourceBundle resourceBundle) {
- try {
- Field resourcesField = view.getClass().getField(NAMING_CONVENTION_RESOURCES_IDENTIFIER);
-
- if (resourcesField.getType().isAssignableFrom(ResourceBundle.class)) {
- resourcesField.set(view, resourceBundle);
- }
- } catch (NoSuchFieldException e) {
- // This exception means that there is no field for the ResourceBundle.
- // This is no exceptional case but is normal when you don't need a resourceBundle in a specific view.
- // Therefore it's save to silently catch the exception.
- } catch (IllegalAccessException e) {
- LOG.warn("Can't inject the ResourceBundle into the view {} because the field isn't accessible", view);
- }
-
-
- }
-
-
+ Initializable initializable = (Initializable) view;
+ initializable.initialize(null, resourceBundle);
+ } else {
+ injectResourceBundle(view, resourceBundle);
+ callInitialize(view);
+ }
+
+ return new ViewTuple<>(view, (Parent) view, viewModel);
+ }
+
+ /**
+ * This method is trying to invoke the initialize method of the given view
+ * by reflection. This is done to meet the conventions of the
+ * {@link javafx.fxml.FXMLLoader}. The conventions say that when there is a
+ * public no-args method with the simple name "initialize"
+ * and the class does not implement the {@link javafx.fxml.Initializable}
+ * interface, the initialize method will be invoked.
+ * This method is package scoped for better testability.
+ *
+ * @param view
+ * the view instance of which the initialize method will be
+ * invoked.
+ * @param
+ * the generic type of the view.
+ */
+ void callInitialize(View view) {
+ try {
+ final Method initializeMethod = view.getClass().getMethod(NAMING_CONVENTION_INITIALIZE_IDENTIFIER);
+
+ AccessController.doPrivileged((PrivilegedAction) () -> {
+ try {
+ return initializeMethod.invoke(view);
+ } catch (InvocationTargetException e) {
+ LOG.warn("The '{}' method of the view {} has thrown an exception!",
+ NAMING_CONVENTION_INITIALIZE_IDENTIFIER, view);
+
+ Throwable cause = e.getCause();
+ if (cause instanceof RuntimeException) {
+ throw (RuntimeException) cause;
+ } else {
+ throw new RuntimeException(cause);
+ }
+ } catch (IllegalAccessException e) {
+ LOG.warn("Can't invoke the '{}' method of the view {} because it is not accessible",
+ NAMING_CONVENTION_INITIALIZE_IDENTIFIER, view);
+ }
+ return null;
+ });
+
+ } catch (NoSuchMethodException e) {
+ // This exception means that there is no initialize method declared.
+ // While it's possible that the user has no such method by design,
+ // normally and in most cases you need an initialize method in your
+ // view (either with Initialize interface
+ // or implicit).
+ // So it's likely that the user has misspelled the method name or
+ // uses a wrong naming convention.
+ // For this reason we give the user the log message.
+ LOG.debug("There is no '{}' method declared at the view {}", NAMING_CONVENTION_INITIALIZE_IDENTIFIER, view);
+ }
+ }
+
+ /**
+ * Injects the given ResourceBundle into the given view using reflection.
+ * This is done to meet the conventions of the
+ * {@link javafx.fxml.FXMLLoader}. The resourceBundle is only injected when
+ * there is a public field of the type
+ * {@link java.util.ResourceBundle} named "resources".
+ * This method is package scoped for better testability.
+ *
+ * @param view
+ * the view instance that gets the resourceBundle injected.
+ * @param resourceBundle
+ * the resourceBundle instance that will be injected.
+ * @param
+ * the generic type of the view.
+ */
+ void injectResourceBundle(View view,
+ ResourceBundle resourceBundle) {
+ try {
+ Field resourcesField = view.getClass().getField(NAMING_CONVENTION_RESOURCES_IDENTIFIER);
+
+ if (resourcesField.getType().isAssignableFrom(ResourceBundle.class)) {
+ resourcesField.set(view, resourceBundle);
+ }
+ } catch (NoSuchFieldException e) {
+ // This exception means that there is no field for the
+ // ResourceBundle.
+ // This is no exceptional case but is normal when you don't need a
+ // resourceBundle in a specific view.
+ // Therefore it's save to silently catch the exception.
+ } catch (IllegalAccessException e) {
+ LOG.warn("Can't inject the ResourceBundle into the view {} because the field isn't accessible", view);
+ }
+
+ }
+
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ReflectionUtils.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ReflectionUtils.java
index 836f6fe0c..c9b681bbb 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ReflectionUtils.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ReflectionUtils.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.internal.viewloader;
import java.lang.annotation.Annotation;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleInjector.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleInjector.java
index 24dcd33b5..8e387ecc0 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleInjector.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleInjector.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.internal.viewloader;
import java.lang.reflect.Field;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleManager.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleManager.java
index 5584b13b4..f17a2213a 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleManager.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ResourceBundleManager.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.internal.viewloader;
import eu.lestard.doc.Internal;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ViewLoaderReflectionUtils.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ViewLoaderReflectionUtils.java
index 0aa2a48aa..755a4e453 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ViewLoaderReflectionUtils.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ViewLoaderReflectionUtils.java
@@ -1,263 +1,403 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.internal.viewloader;
-import de.saxsys.mvvmfx.InjectViewModel;
-import de.saxsys.mvvmfx.ViewModel;
-import net.jodah.typetools.TypeResolver;
-
+import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.List;
+import java.util.Map;
import java.util.Optional;
+import java.util.function.Consumer;
import java.util.stream.Collectors;
+import de.saxsys.mvvmfx.Context;
+import de.saxsys.mvvmfx.InjectContext;
+import de.saxsys.mvvmfx.InjectScope;
+import de.saxsys.mvvmfx.InjectViewModel;
+import de.saxsys.mvvmfx.Scope;
+import de.saxsys.mvvmfx.ScopeProvider;
+import de.saxsys.mvvmfx.ViewModel;
+import de.saxsys.mvvmfx.internal.ContextImpl;
+import net.jodah.typetools.TypeResolver;
+
/**
- * This class encapsulates reflection related utility operations specific for loading of views.
+ * This class encapsulates reflection related utility operations specific for
+ * loading of views.
*
* @author manuel.mauky
*/
public class ViewLoaderReflectionUtils {
-
-
-
- /**
- * Returns the {@link java.lang.reflect.Field} of the viewModel for a given view type and viewModel type. If there
- * is no annotated field for the viewModel in the view the returned Optional will be empty.
- *
- * @param viewType
- * the type of the view
- * @param viewModelType
- * the type of the viewModel
- * @return an Optional that contains the Field when the field exists.
- */
- public static Optional getViewModelField(Class viewType, Class viewModelType) {
- List allViewModelFields = getViewModelFields(viewType);
-
- if (allViewModelFields.isEmpty()) {
- return Optional.empty();
- }
-
- if (allViewModelFields.size() > 1) {
- throw new RuntimeException("The View <" + viewType + "> may only define one viewModel but there were <"
- + allViewModelFields.size() + "> viewModel fields with the @InjectViewModel annotation!");
- }
-
- Field field = allViewModelFields.get(0);
-
- if (!ViewModel.class.isAssignableFrom(field.getType())) {
- throw new RuntimeException(
- "The View <"
- + viewType
- + "> has a field annotated with @InjectViewModel but the type of the field doesn't implement the 'ViewModel' interface!");
- }
-
- if (!field.getType().isAssignableFrom(viewModelType)) {
- throw new RuntimeException(
- "The View <"
- + viewType
- + "> has a field annotated with @InjectViewModel but the type of the field doesn't match the generic ViewModel type of the View class. "
- + "The declared generic type is <" + viewModelType
- + "> but the actual type of the field is <" + field.getType() + ">.");
- }
-
- return Optional.of(field);
- }
-
-
- /**
- * Returns a list of all {@link Field}s of ViewModels for a given view type that are annotated with
- * {@link InjectViewModel}.
- *
- * @param viewType
- * the type of the view.
- * @return a list of fields.
- */
- public static List getViewModelFields(Class viewType) {
- return ReflectionUtils.getFieldsFromClassHierarchy(viewType).stream()
- .filter(field -> field.isAnnotationPresent(InjectViewModel.class))
- .collect(Collectors.toList());
- }
-
-
-
-
- /**
- * This method is used to get the ViewModel instance of a given view/codeBehind.
- *
- * @param view
- * the view instance where the viewModel will be looked for.
- * @param
- * the generic type of the View
- * @param
- * the generic type of the ViewModel
- * @return the ViewModel instance or null if no viewModel could be found.
- */
- @SuppressWarnings("unchecked")
- public static , ViewModelType extends ViewModel> ViewModelType getExistingViewModel(
- ViewType view) {
- final Class viewModelType = TypeResolver.resolveRawArgument(View.class, view.getClass());
- Optional fieldOptional = getViewModelField(view.getClass(), viewModelType);
- if (fieldOptional.isPresent()) {
- Field field = fieldOptional.get();
- return ReflectionUtils
- .accessField(field, () -> (ViewModelType) field.get(view), "Can't get the viewModel of type <"
- + viewModelType + ">");
- } else {
- return null;
- }
- }
-
- /**
- * Injects the given viewModel instance into the given view. The injection will only happen when the class of the
- * given view has a viewModel field that fulfills all requirements for the viewModel injection (matching types, no
- * viewModel already existing ...).
- *
- * @param view
- * @param viewModel
- */
- public static void injectViewModel(final View view, ViewModel viewModel) {
- if (viewModel == null) {
- return;
- }
- final Optional fieldOptional = getViewModelField(view.getClass(), viewModel.getClass());
- if (fieldOptional.isPresent()) {
- Field field = fieldOptional.get();
- ReflectionUtils.accessField(field, () -> {
- Object existingViewModel = field.get(view);
- if (existingViewModel == null) {
- field.set(view, viewModel);
- }
- }, "Can't inject ViewModel of type <" + viewModel.getClass()
- + "> into the view <" + view + ">");
- }
- }
-
- /**
- * This method is used to create and inject the ViewModel for a given View instance. The ViewModel is only created
- * if the View has a suitable field for the ViewModel.
- *
- * If a ViewModel was created OR there was already a ViewModel set in the View, this viewModel instance is returned
- * via an Optional.
- *
- * @param view
- * the view instance.
- * @param
- * the generic type of the View.
- * @param
- * the generic type of the ViewModel.
- * @return an Optional containing the ViewModel if it was created or already existing. Otherwise the Optional is
- * empty.
- *
- * @throws RuntimeException
- * if there is a ViewModel field in the View with the {@link InjectViewModel} annotation whose type
- * doesn't match the generic ViewModel type from the View class.
- */
- @SuppressWarnings("unchecked")
- public static , VM extends ViewModel> Optional createAndInjectViewModel(
- final V view) {
- final Class viewModelType = TypeResolver.resolveRawArgument(View.class, view.getClass());
-
- if (viewModelType == ViewModel.class) {
- // if no viewModel can be created, we have to check if the user has tried to inject a ViewModel
+
+ /**
+ * Returns the {@link java.lang.reflect.Field} of the viewModel for a given
+ * view type and viewModel type. If there is no annotated field for the
+ * viewModel in the view the returned Optional will be empty.
+ *
+ * @param viewType
+ * the type of the view
+ * @param viewModelType
+ * the type of the viewModel
+ * @return an Optional that contains the Field when the field exists.
+ */
+ public static Optional getViewModelField(Class viewType, Class viewModelType) {
+ List allViewModelFields = getViewModelFields(viewType);
+
+ if (allViewModelFields.isEmpty()) {
+ return Optional.empty();
+ }
+
+ if (allViewModelFields.size() > 1) {
+ throw new RuntimeException("The View <" + viewType + "> may only define one viewModel but there were <"
+ + allViewModelFields.size() + "> viewModel fields with the @InjectViewModel annotation!");
+ }
+
+ Field field = allViewModelFields.get(0);
+
+ if (!ViewModel.class.isAssignableFrom(field.getType())) {
+ throw new RuntimeException("The View <" + viewType
+ + "> has a field annotated with @InjectViewModel but the type of the field doesn't implement the 'ViewModel' interface!");
+ }
+
+ if (!field.getType().isAssignableFrom(viewModelType)) {
+ throw new RuntimeException("The View <" + viewType
+ + "> has a field annotated with @InjectViewModel but the type of the field doesn't match the generic ViewModel type of the View class. "
+ + "The declared generic type is <" + viewModelType + "> but the actual type of the field is <"
+ + field.getType() + ">.");
+ }
+
+ return Optional.of(field);
+ }
+
+ public static List getScopeFields(Class viewModelType) {
+ final List allScopeFields = getFieldsWithAnnotation(viewModelType, InjectScope.class);
+
+ allScopeFields.stream().forEach(field -> {
+ if (!Scope.class.isAssignableFrom(field.getType())) {
+ throw new RuntimeException("The ViewModel <" + viewModelType
+ + "> has a field annotated with @InjectScope but the type of the field doesn't implement the 'Scope' interface!");
+ }
+ });
+
+ return allScopeFields;
+ }
+
+ private static Optional getContextField(Class viewType) {
+ List allViewModelFields = getContextFields(viewType);
+
+ if (allViewModelFields.isEmpty()) {
+ return Optional.empty();
+ }
+
+ if (allViewModelFields.size() > 1) {
+ throw new RuntimeException("The View <" + viewType + "> may only define one Context but there were <"
+ + allViewModelFields.size() + "> Context fields with the @InjectContext annotation!");
+ }
+
+ Field field = allViewModelFields.get(0);
+
+ if (!field.getType().isAssignableFrom(Context.class)) {
+ throw new RuntimeException("The View <" + viewType
+ + "> has a field annotated with @InjectContext but the type of the field doesn't match the type Context. "
+ + "The actual type of the field is <" + field.getType() + ">.");
+ }
+
+ return Optional.of(field);
+ }
+
+ private static List getContextFields(Class viewType) {
+ return getFieldsWithAnnotation(viewType, InjectContext.class);
+ }
+
+ /**
+ * Returns a list of all {@link Field}s of ViewModels for a given view type
+ * that are annotated with {@link InjectViewModel}.
+ *
+ * @param viewType
+ * the type of the view.
+ * @return a list of fields.
+ */
+ public static List getViewModelFields(Class viewType) {
+ return getFieldsWithAnnotation(viewType, InjectViewModel.class);
+ }
+
+ private static List getFieldsWithAnnotation(Class classType,
+ Class annotationType) {
+ return ReflectionUtils.getFieldsFromClassHierarchy(classType)
+ .stream()
+ .filter(field -> field.isAnnotationPresent(annotationType))
+ .collect(Collectors.toList());
+ }
+
+ /**
+ * This method is used to get the ViewModel instance of a given
+ * view/codeBehind.
+ *
+ * @param view
+ * the view instance where the viewModel will be looked for.
+ * @param
+ * the generic type of the View
+ * @param
+ * the generic type of the ViewModel
+ * @return the ViewModel instance or null if no viewModel could be found.
+ */
+ @SuppressWarnings("unchecked")
+ public static , ViewModelType extends ViewModel> ViewModelType getExistingViewModel(
+ ViewType view) {
+ final Class viewModelType = TypeResolver.resolveRawArgument(View.class, view.getClass());
+ Optional fieldOptional = getViewModelField(view.getClass(), viewModelType);
+ if (fieldOptional.isPresent()) {
+ Field field = fieldOptional.get();
+ return ReflectionUtils.accessField(field, () -> (ViewModelType) field.get(view),
+ "Can't get the viewModel of type <" + viewModelType + ">");
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Injects the given viewModel instance into the given view. The injection
+ * will only happen when the class of the given view has a viewModel field
+ * that fulfills all requirements for the viewModel injection (matching
+ * types, no viewModel already existing ...).
+ *
+ * @param view
+ * @param viewModel
+ */
+ public static void injectViewModel(final View view, ViewModel viewModel) {
+ if (viewModel == null) {
+ return;
+ }
+ final Optional fieldOptional = getViewModelField(view.getClass(), viewModel.getClass());
+ if (fieldOptional.isPresent()) {
+ Field field = fieldOptional.get();
+ ReflectionUtils.accessField(field, () -> {
+ Object existingViewModel = field.get(view);
+ if (existingViewModel == null) {
+ field.set(view, viewModel);
+ }
+ }, "Can't inject ViewModel of type <" + viewModel.getClass() + "> into the view <" + view + ">");
+ }
+ }
+
+ /**
+ * This method is used to create and inject the ViewModel for a given View
+ * instance.
+ *
+ * The following checks are done:
+ *
+ * - Check whether the View class specifies a ViewModel type as generic
+ * type.
+ * - Check whether the View has a field with a matching ViewModel type and
+ * the annotation {@link InjectViewModel}.
+ *
+ * - Check whether field in the view instance already contains a ViewModel
+ * instance. In this case nothing will happen to the existing ViewModel
+ * instance.
+ *
+ *
+ *
+ * If a suitable field was found a new ViewModel instance will be created
+ * and injected into the field. After that the given Consumer function will
+ * be applied with the injected ViewModel instance as argument.
+ *
+ * @param view
+ * the view instance.
+ * @param
+ * the generic type of the View.
+ * @param
+ * the generic type of the ViewModel.
+ * @param newVmConsumer
+ * a Consumer function that is applied when a new ViewModel
+ * instance is created.
+ *
+ * @throws RuntimeException
+ * if there is a ViewModel field in the View with the
+ * {@link InjectViewModel} annotation whose type doesn't match
+ * the generic ViewModel type from the View class.
+ */
+ @SuppressWarnings("unchecked")
+ public static , VM extends ViewModel> void createAndInjectViewModel(final V view,
+ Consumer newVmConsumer) {
+ final Class viewModelType = TypeResolver.resolveRawArgument(View.class, view.getClass());
+
+ if (viewModelType == ViewModel.class) {
+ // if no viewModel can be created, we have to check if the user has
+ // tried to inject a ViewModel
final List viewModelFields = ViewLoaderReflectionUtils.getViewModelFields(view.getClass());
- if(!viewModelFields.isEmpty()) {
- throw new RuntimeException("The given view of type <" + view.getClass() + "> has no generic viewModel type declared but tries to inject a viewModel.");
+ if (!viewModelFields.isEmpty()) {
+ throw new RuntimeException("The given view of type <" + view.getClass()
+ + "> has no generic viewModel type declared but tries to inject a viewModel.");
}
+ return;
+ }
+ if (viewModelType == TypeResolver.Unknown.class) {
+ return;
+ }
+
+ final Optional fieldOptional = getViewModelField(view.getClass(), viewModelType);
+ if (fieldOptional.isPresent()) {
+ Field field = fieldOptional.get();
+
+ ReflectionUtils.accessField(field, () -> {
+ Object existingViewModel = field.get(view);
+
+ if (existingViewModel == null) {
+ final Object newViewModel = DependencyInjector.getInstance().getInstanceOf(viewModelType);
+
+ field.set(view, newViewModel);
+
+ newVmConsumer.accept((ViewModel) newViewModel);
+ }
+ }, "Can't inject ViewModel of type <" + viewModelType + "> into the view <" + view + ">");
+
+ }
+ }
+
+ static void createAndInjectScopes(Object viewModel, ContextImpl context) {
+
+ // FIXME CLEANUP!!!
+ Class viewModelClass = viewModel.getClass();
+
+ for (Annotation annotation : viewModelClass.getDeclaredAnnotations()) {
+ if (annotation.annotationType().isAssignableFrom(ScopeProvider.class)) {
+ ScopeProvider provider = (ScopeProvider) annotation;
+ Class[] scopes = provider.scopes();
+ for (int i = 0; i < scopes.length; i++) {
+ Class scopeType = scopes[i];
+ // Overrides existing scopes!!!!
+ context.addScopeToContext(DependencyInjector.getInstance().getInstanceOf(scopeType));
+ }
+ }
+ }
+
+ // Inject
+ List scopeFields = getScopeFields(viewModel.getClass());
+
+ scopeFields.forEach(scopeField -> {
+ ReflectionUtils.accessField(scopeField, () -> injectScopeIntoField(scopeField, viewModel, context),
+ "Can't inject Scope into ViewModel <" + viewModel.getClass() + ">");
+ });
+ }
+
+ public static void injectContext(View codeBehind, ContextImpl context) {
+
+ Optional contextField = getContextField(codeBehind.getClass());
+
+ if (contextField.isPresent()) {
+ Field field = contextField.get();
+ ReflectionUtils.accessField(field, () -> {
+ field.set(codeBehind, context);
+ }, "Can't inject Context into the view <" + codeBehind + ">");
+ }
+ }
+
+ static Object injectScopeIntoField(Field scopeField, Object viewModel, ContextImpl context)
+ throws IllegalAccessException {
+ Class scopeType = (Class) scopeField.getType();
+
+ // FIXME
+
+ final InjectScope[] annotations = scopeField.getAnnotationsByType(InjectScope.class);
+
+ if (annotations.length != 1) {
+ throw new RuntimeException("A field to inject a Scope into should have exactly one @InjectScope annotation "
+ + "but the viewModel <" + viewModel + "> has a field that violates this rule.");
+ }
+
+ Object newScope = context.getScope(scopeType);
+
+ if (newScope == null) {
+ // TODO Modify Stacktrace to get the Injectionpoint of the Scope
+ throw new IllegalStateException(
+ "A scope was requested but no @ScopeProvider found in the hirarchy. Declare it like this: @ScopeProvider("
+ + scopeType.getName() + ")");
+ }
+
+ if (!newScope.getClass().equals(scopeType)) {
+ throw new IllegalStateException("something went wrong...");
+ }
+
+ scopeField.set(viewModel, newScope);
+
+ return newScope;
+ }
+
+ /**
+ * Creates a viewModel instance for a View type. The type of the view is
+ * determined by the given view instance.
+ *
+ * For the creation of the viewModel the {@link DependencyInjector} is used.
+ *
+ * @param view
+ * the view instance that is used to find out the type of the
+ * ViewModel
+ * @param
+ * the generic view type
+ * @param
+ * the generic viewModel type
+ * @return the viewModel instance or null if the viewModel type
+ * can't be found or the viewModel can't be created.
+ */
+ @SuppressWarnings("unchecked")
+ public static , ViewModelType extends ViewModel> ViewModelType createViewModel(
+ ViewType view) {
+ final Class viewModelType = TypeResolver.resolveRawArgument(View.class, view.getClass());
+ if (viewModelType == ViewModel.class) {
+ return null;
+ }
+ if (TypeResolver.Unknown.class == viewModelType) {
+ return null;
+ }
+ return (ViewModelType) DependencyInjector.getInstance().getInstanceOf(viewModelType);
+ }
+
+ /**
+ * If a ViewModel has a method with the signature
+ * public void initialize() it will be invoked. If no such
+ * method is available nothing happens.
+ *
+ * @param viewModel
+ * the viewModel that's initialize method (if available) will be
+ * invoked.
+ * @param
+ * the generic type of the ViewModel.
+ */
+ public static void initializeViewModel(ViewModelType viewModel) {
+ if (viewModel == null) {
+ return;
+ }
+ try {
+ final Method initMethod = viewModel.getClass().getMethod("initialize");
+ AccessController.doPrivileged((PrivilegedAction) () -> {
+ try {
+ return initMethod.invoke(viewModel);
+ } catch (InvocationTargetException | IllegalAccessException e) {
+ throw new IllegalStateException(
+ "mvvmFX wasn't able to call the initialize method of ViewModel [" + viewModel + "].", e);
+ }
+ });
+ } catch (NoSuchMethodException e) {
+ // it's perfectly fine that a ViewModel has no initialize method.
+ }
+ }
- return Optional.empty();
- }
- if (viewModelType == TypeResolver.Unknown.class) {
- return Optional.empty();
- }
-
- final Optional fieldOptional = getViewModelField(view.getClass(), viewModelType);
- if (fieldOptional.isPresent()) {
- Field field = fieldOptional.get();
-
- Object viewModel = ReflectionUtils.accessField(field, () -> {
- Object existingViewModel = field.get(view);
-
- if (existingViewModel != null) {
- return existingViewModel;
- } else {
- final Object newViewModel = DependencyInjector.getInstance().getInstanceOf(viewModelType);
-
- field.set(view, newViewModel);
-
- return newViewModel;
- }
- }, "Can't inject ViewModel of type <" + viewModelType
- + "> into the view <" + view + ">");
-
- if (viewModel == null) {
- return Optional.empty();
- }
-
- try {
- return Optional.of((VM) viewModel);
- } catch (ClassCastException e) {
- return Optional.empty();
- }
- }
-
- return Optional.empty();
- }
-
- /**
- * Creates a viewModel instance for a View type. The type of the view is determined by the given view instance.
- *
- * For the creation of the viewModel the {@link DependencyInjector} is used.
- *
- * @param view
- * the view instance that is used to find out the type of the ViewModel
- * @param
- * the generic view type
- * @param
- * the generic viewModel type
- * @return the viewModel instance or null if the viewModel type can't be found or the viewModel can't
- * be created.
- */
- @SuppressWarnings("unchecked")
- public static , ViewModelType extends ViewModel> ViewModelType createViewModel(
- ViewType view) {
- final Class viewModelType = TypeResolver.resolveRawArgument(View.class, view.getClass());
- if (viewModelType == ViewModel.class) {
- return null;
- }
- if (TypeResolver.Unknown.class == viewModelType) {
- return null;
- }
- return (ViewModelType) DependencyInjector.getInstance().getInstanceOf(viewModelType);
- }
-
-
- /**
- * If a ViewModel has a method with the signature public void initialize() it will be invoked. If no
- * such method is available nothing happens.
- *
- * @param viewModel
- * the viewModel that's initialize method (if available) will be invoked.
- * @param
- * the generic type of the ViewModel.
- */
- public static void initializeViewModel(ViewModelType viewModel) {
- try {
- final Method initMethod = viewModel.getClass().getMethod("initialize");
-
- AccessController.doPrivileged((PrivilegedAction) () -> {
- try {
- return initMethod.invoke(viewModel);
- } catch (InvocationTargetException | IllegalAccessException e) {
- throw new IllegalStateException("mvvmFX wasn't able to call the initialize method of ViewModel ["
- + viewModel + "].", e);
- }
- });
- } catch (NoSuchMethodException e) {
- // it's perfectly fine that a ViewModel has no initialize method.
- }
- }
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ViewLoaderScopeUtils.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ViewLoaderScopeUtils.java
new file mode 100644
index 000000000..c914391db
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/internal/viewloader/ViewLoaderScopeUtils.java
@@ -0,0 +1,30 @@
+package de.saxsys.mvvmfx.internal.viewloader;
+
+import java.util.Collection;
+
+import de.saxsys.mvvmfx.Context;
+import de.saxsys.mvvmfx.Scope;
+import de.saxsys.mvvmfx.internal.ContextImpl;
+
+class ViewLoaderScopeUtils {
+
+ static ContextImpl prepareContext(Context parentContext, Collection providedScopes) {
+ ContextImpl context = null;
+
+ if (parentContext == null || !(parentContext instanceof ContextImpl)) {
+ context = new ContextImpl();
+ } else {
+ context = (ContextImpl) parentContext;
+ }
+
+ if (providedScopes != null) {
+
+ for (Scope scope : providedScopes) {
+ context.addScopeToContext(scope);
+ }
+ }
+
+ return context;
+ }
+
+}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/Action.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/Action.java
index 797a5c43b..f160b6afc 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/Action.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/Action.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.commands;
import javafx.concurrent.Task;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/DelegateCommand.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/DelegateCommand.java
index d369e1a05..75192c7b6 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/DelegateCommand.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/commands/DelegateCommand.java
@@ -18,9 +18,11 @@
import java.util.function.Supplier;
import javafx.application.Platform;
+import javafx.beans.binding.Bindings;
import javafx.beans.property.ReadOnlyBooleanProperty;
import javafx.beans.property.ReadOnlyBooleanWrapper;
import javafx.beans.value.ObservableBooleanValue;
+import javafx.beans.value.ObservableValue;
import javafx.concurrent.Service;
import javafx.concurrent.Task;
import eu.lestard.doc.Beta;
@@ -74,19 +76,19 @@ public DelegateCommand(final Supplier actionSupplier, boolean inBackgrou
}
/**
- * Creates a command with a condition about the executability by using the #executableBinding parameter.
+ * Creates a command with a condition about the executability by using the 'executableObservable' parameter.
*
* @param actionSupplier
* a function that returns a new Action which should be executed
- * @param executableBinding
+ * @param executableObservable
* which defines whether the {@link Command} can execute
*/
- public DelegateCommand(final Supplier actionSupplier, ObservableBooleanValue executableBinding) {
- this(actionSupplier, executableBinding, false);
+ public DelegateCommand(final Supplier actionSupplier, ObservableValue executableObservable) {
+ this(actionSupplier, executableObservable, false);
}
/**
- * Creates a command with a condition about the executability by using the #executableBinding parameter. Pass a
+ * Creates a command with a condition about the executability by using the 'executableObservable' parameter. Pass a
* true to the #inBackground parameter to run the {@link Command} in a background thread.
*
* IF YOU USE THE BACKGROUND THREAD: don't forget to return to the UI-thread by using
@@ -94,17 +96,22 @@ public DelegateCommand(final Supplier actionSupplier, ObservableBooleanV
*
* @param actionSupplier
* a function that returns a new Action which should be executed
- * @param executableBinding
+ * @param executableObservable
* which defines whether the {@link Command} can execute
* @param inBackground
* defines whether the execution {@link #execute()} is performed in a background thread or not
*/
- public DelegateCommand(final Supplier actionSupplier, ObservableBooleanValue executableBinding,
+ public DelegateCommand(final Supplier actionSupplier, ObservableValue executableObservable,
boolean inBackground) {
this.actionSupplier = actionSupplier;
this.inBackground = inBackground;
- if (executableBinding != null) {
- executable.bind(runningProperty().not().and(executableBinding));
+ if (executableObservable != null) {
+ executable.bind(Bindings.createBooleanBinding(() -> {
+ final boolean isRunning = runningProperty().get();
+ final boolean isExecutable = executableObservable.getValue();
+
+ return !isRunning && isExecutable;
+ }, runningProperty(), executableObservable));
}
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/ModelWrapper.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/ModelWrapper.java
index 339b62b91..06704b8d8 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/ModelWrapper.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/ModelWrapper.java
@@ -1,17 +1,20 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.Set;
-import java.util.function.BiConsumer;
-import java.util.function.Function;
-import java.util.function.Supplier;
-
import de.saxsys.mvvmfx.utils.mapping.accessorfunctions.BooleanGetter;
import de.saxsys.mvvmfx.utils.mapping.accessorfunctions.BooleanPropertyAccessor;
import de.saxsys.mvvmfx.utils.mapping.accessorfunctions.BooleanSetter;
@@ -36,6 +39,20 @@
import de.saxsys.mvvmfx.utils.mapping.accessorfunctions.StringGetter;
import de.saxsys.mvvmfx.utils.mapping.accessorfunctions.StringPropertyAccessor;
import de.saxsys.mvvmfx.utils.mapping.accessorfunctions.StringSetter;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+import java.util.function.BiConsumer;
+import java.util.function.Function;
+import java.util.function.Supplier;
+
import eu.lestard.doc.Beta;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.DoubleProperty;
@@ -237,8 +254,7 @@ public class ModelWrapper {
private final ReadOnlyBooleanWrapper dirtyFlag = new ReadOnlyBooleanWrapper();
private final ReadOnlyBooleanWrapper diffFlag = new ReadOnlyBooleanWrapper();
-
-
+
/**
* This interface defines the operations that are possible for each field of a wrapped class.
*
@@ -256,14 +272,16 @@ private interface PropertyField> {
void reload(M wrappedObject);
void resetToDefault();
-
+
+ void updateDefault(final M wrappedObject);
+
R getProperty();
-
+
/**
* Determines if the value in the model object and the property field are different or not.
- *
+ *
* This method is used to implement the {@link #differentProperty()} flag.
- *
+ *
* @param wrappedObject
* the wrapped model object
* @return false if both the wrapped model object and the property field have the same value,
@@ -280,7 +298,7 @@ private interface PropertyField> {
*/
private class FxPropertyField> implements PropertyField {
- private final T defaultValue;
+ private T defaultValue;
private final Function> accessor;
private final R targetProperty;
@@ -312,7 +330,12 @@ public void reload(M wrappedObject) {
public void resetToDefault() {
targetProperty.setValue(defaultValue);
}
-
+
+ @Override
+ public void updateDefault(final M wrappedObject) {
+ defaultValue = accessor.apply(wrappedObject).getValue();
+ }
+
@Override
public R getProperty() {
return targetProperty;
@@ -336,7 +359,7 @@ public boolean isDifferent(M wrappedObject) {
private class BeanPropertyField> implements PropertyField {
private final R targetProperty;
- private final T defaultValue;
+ private T defaultValue;
private final Function getter;
private final BiConsumer setter;
@@ -370,7 +393,12 @@ public void reload(M wrappedObject) {
public void resetToDefault() {
targetProperty.setValue(defaultValue);
}
-
+
+ @Override
+ public void updateDefault(final M wrappedObject) {
+ defaultValue = getter.apply(wrappedObject);
+ }
+
@Override
public R getProperty() {
return targetProperty;
@@ -396,7 +424,7 @@ public boolean isDifferent(M wrappedObject) {
private class FxListPropertyField, R extends Property>
implements PropertyField {
- private final List defaultValue;
+ private List defaultValue;
private final ListPropertyAccessor accessor;
private final ListProperty targetProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
@@ -425,7 +453,12 @@ public void reload(M wrappedObject) {
public void resetToDefault() {
targetProperty.setAll(defaultValue);
}
-
+
+ @Override
+ public void updateDefault(final M wrappedObject) {
+ defaultValue = new ArrayList<>(accessor.apply(wrappedObject).getValue());
+ }
+
@Override
public R getProperty() {
return (R) targetProperty;
@@ -455,7 +488,7 @@ private class BeanListPropertyField, R extends Pr
private final ListGetter getter;
private final ListSetter setter;
- private final List defaultValue;
+ private List defaultValue;
private final ListProperty targetProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
public BeanListPropertyField(ListGetter getter, ListSetter setter) {
@@ -484,7 +517,12 @@ public void reload(M wrappedObject) {
public void resetToDefault() {
targetProperty.setAll(defaultValue);
}
-
+
+ @Override
+ public void updateDefault(final M wrappedObject) {
+ defaultValue = new ArrayList<>(getter.apply(wrappedObject));
+ }
+
@Override
public R getProperty() {
return (R) targetProperty;
@@ -499,12 +537,28 @@ public boolean isDifferent(M wrappedObject) {
}
}
- private final Set> fields = new HashSet<>();
+ private final Set> fields = new LinkedHashSet<>();
private final Map> identifiedFields = new HashMap<>();
- private M model;
-
-
+ private final ObjectProperty model;
+
+
+ /**
+ * Create a new instance of {@link ModelWrapper} that wraps the instance of the Model class wrapped by the property.
+ * Updates all data when the model instance changes.
+ *
+ * @param model
+ * the property of the model element that will be wrapped.
+ */
+ public ModelWrapper(ObjectProperty model) {
+ this.model = model;
+ reload();
+ this.model.addListener((observable, oldValue, newValue) -> {
+ reload();
+ useCurrentValuesAsDefaults();
+ });
+ }
+
/**
* Create a new instance of {@link ModelWrapper} that wraps the given instance of the Model class.
*
@@ -512,8 +566,7 @@ public boolean isDifferent(M wrappedObject) {
* the element of the model that will be wrapped.
*/
public ModelWrapper(M model) {
- set(model);
- reload();
+ this(new SimpleObjectProperty<>(model));
}
/**
@@ -521,6 +574,7 @@ public ModelWrapper(M model) {
* that should be wrapped afterwards with the {@link #set(Object)} method.
*/
public ModelWrapper() {
+ this(new SimpleObjectProperty<>());
}
/**
@@ -530,16 +584,23 @@ public ModelWrapper() {
* the element of the model that will be wrapped.
*/
public void set(M model) {
- this.model = model;
+ this.model.set(model);
}
/**
* @return the wrapped model element if one was defined, otherwise null.
*/
public M get() {
+ return model.get();
+ }
+
+ /**
+ * @return property holding the model instance wrapped by this model wrapper instance.
+ */
+ public ObjectProperty modelProperty() {
return model;
}
-
+
/**
* Resets all defined fields to their default values. If no default value was defined null will be used
* instead.
@@ -552,7 +613,51 @@ public void reset() {
calculateDifferenceFlag();
}
-
+
+ /**
+ * Use all values that are currently present in the wrapped model object as new default values for respective field.
+ * This overrides/updates the values that were set during the initialization of the field mappings.
+ *
+ * Subsequent calls to {@link #reset()} will reset the values to this new default values.
+ *
+ * Usage example:
+ *
+ * ModelWrapper{@code} wrapper = new ModelWrapper{@code<>}();
+ *
+ * wrapper.field(Person::getName, Person::setName, "oldDefault");
+ *
+ * Person p = new Person();
+ * wrapper.set(p);
+ *
+ *
+ * p.setName("Luise");
+ *
+ * wrapper.useCurrentValuesAsDefaults(); // now "Luise" is the default value for the name field.
+ *
+ *
+ * name.set("Hugo");
+ * wrapper.commit();
+ *
+ * name.get(); // Hugo
+ * p.getName(); // Hugo
+ *
+ *
+ * wrapper.reset(); // reset to the new defaults
+ * name.get(); // Luise
+ *
+ * wrapper.commit(); // put values from properties to the wrapped model object
+ * p.getName(); // Luise
+ *
+ *
+ *
+ *
+ */
+ public void useCurrentValuesAsDefaults() {
+ for (final PropertyField field : fields) {
+ field.updateDefault(model.get());
+ }
+ }
+
/**
* Take the current value of each property field and write it into the wrapped model element.
*
@@ -562,8 +667,8 @@ public void reset() {
* state of the wrapped model element.
*/
public void commit() {
- if (model != null) {
- fields.forEach(field -> field.commit(model));
+ if (model.get() != null) {
+ fields.forEach(field -> field.commit(model.get()));
dirtyFlag.set(false);
@@ -580,8 +685,8 @@ public void commit() {
* defined property fields.
*/
public void reload() {
- if (model != null) {
- fields.forEach(field -> field.reload(model));
+ if (model.get() != null) {
+ fields.forEach(field -> field.reload(model.get()));
dirtyFlag.set(false);
calculateDifferenceFlag();
@@ -596,9 +701,9 @@ private void propertyWasChanged() {
}
private void calculateDifferenceFlag() {
- if (model != null) {
+ if (model.get() != null) {
final Optional> optional = fields.stream()
- .filter(field -> field.isDifferent(model))
+ .filter(field -> field.isDifferent(model.get()))
.findAny();
diffFlag.set(optional.isPresent());
@@ -1092,8 +1197,8 @@ public ListProperty field(String identifier, ListPropertyAccessor a
private > R add(PropertyField field) {
fields.add(field);
- if (model != null) {
- field.reload(model);
+ if (model.get() != null) {
+ field.reload(model.get());
}
return field.getProperty();
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanGetter.java
index 639e3daee..216955123 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanPropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanPropertyAccessor.java
index f36e7aa18..f01797241 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanPropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanPropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import javafx.beans.property.Property;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanSetter.java
index 05ad65113..236d2af47 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/BooleanSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.BiConsumer;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleGetter.java
index 32c33c75c..15ee26e6d 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoublePropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoublePropertyAccessor.java
index ecfadcfed..d9bbea59c 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoublePropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoublePropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleSetter.java
index 74c8376b4..a198801fc 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/DoubleSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.BiConsumer;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatGetter.java
index c04f95055..ebcdd42ba 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatPropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatPropertyAccessor.java
index 09c914913..0f3fa9fd0 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatPropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatPropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import javafx.beans.property.FloatProperty;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatSetter.java
index 68199b5f0..5ca38cf68 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/FloatSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.BiConsumer;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntGetter.java
index c413c3379..d0f65c24f 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntPropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntPropertyAccessor.java
index ceeeda826..ec97e8e0b 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntPropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntPropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import javafx.beans.property.IntegerProperty;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntSetter.java
index 654f321f3..371c539d3 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/IntSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.BiConsumer;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListGetter.java
index f36f97d80..ebd946394 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.List;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListPropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListPropertyAccessor.java
index 28d7b2e5d..719821587 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListPropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListPropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import javafx.beans.property.ListProperty;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListSetter.java
index 62d71fcfa..527faa4f7 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ListSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.List;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongGetter.java
index 85d3f6a60..2c16520c2 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongPropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongPropertyAccessor.java
index 145d20f34..075126003 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongPropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongPropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import javafx.beans.property.LongProperty;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongSetter.java
index d53d0613d..38cd37fe8 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/LongSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.BiConsumer;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectGetter.java
index e035ff01b..18e86907a 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectPropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectPropertyAccessor.java
index 5deca65ba..041622026 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectPropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectPropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import javafx.beans.property.Property;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectSetter.java
index aff8be60a..7931eecf6 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/ObjectSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.BiConsumer;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringGetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringGetter.java
index 8c9838892..3c884104c 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringGetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringGetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.Function;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringPropertyAccessor.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringPropertyAccessor.java
index 3fd6772ba..9667b32de 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringPropertyAccessor.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringPropertyAccessor.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import javafx.beans.property.Property;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringSetter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringSetter.java
index 0fa709647..6cee2a314 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringSetter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/mapping/accessorfunctions/StringSetter.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.mapping.accessorfunctions;
import java.util.function.BiConsumer;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/DefaultNotificationCenter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/DefaultNotificationCenter.java
index 23b6f2892..7af4cbb1a 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/DefaultNotificationCenter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/DefaultNotificationCenter.java
@@ -1,12 +1,12 @@
/*******************************************************************************
* Copyright 2013 Alexander Casall
- *
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -15,49 +15,43 @@
******************************************************************************/
package de.saxsys.mvvmfx.utils.notifications;
-import de.saxsys.mvvmfx.ViewModel;
import javafx.application.Platform;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import java.util.ArrayList;
import java.util.Collection;
-import java.util.Collections;
import java.util.HashMap;
import java.util.List;
-import java.util.stream.Collectors;
+import java.util.concurrent.CopyOnWriteArrayList;
/**
* Default implementation of {@link NotificationCenter}.
- *
+ *
* @author sialcasa
- *
+ *
*/
-class DefaultNotificationCenter implements NotificationCenter {
-
+public class DefaultNotificationCenter implements NotificationCenter {
+
private static final Logger LOG = LoggerFactory.getLogger(DefaultNotificationCenter.class);
-
- DefaultNotificationCenter() {
- }
-
+
private final ObserverMap globalObservers = new ObserverMap();
- private final ViewModelObservers viewModelObservers = new ViewModelObservers();
-
+ private final ChannelObserverMap channelObserverMap = new ChannelObserverMap();
+
@Override
public void subscribe(String messageName, NotificationObserver observer) {
addObserver(messageName, observer, globalObservers);
}
-
+
@Override
public void unsubscribe(String messageName, NotificationObserver observer) {
removeObserversForMessageName(messageName, observer, globalObservers);
}
-
+
@Override
public void unsubscribe(NotificationObserver observer) {
removeObserverFromObserverMap(observer, globalObservers);
}
-
+
@Override
public void publish(String messageName, Object... payload) {
publish(messageName, payload, globalObservers);
@@ -67,25 +61,25 @@ public void publish(String messageName, Object... payload) {
* This notification will be send to the UI-Thread (if the UI-toolkit was bootstrapped).
* If no UI-Toolkit is available the notification will be directly published. This is typically the case in unit tests.
*
- * @param viewModel the ViewModel
- * @param messageName the message to sent
- * @param payload additional arguments to the message
+ * @param channel the channel
+ * @param messageName the message to sent
+ * @param payload additional arguments to the message
*/
@Override
- public void publish(ViewModel viewModel, String messageName, Object[] payload) {
- if(viewModelObservers.containsKey(viewModel)) {
- final ObserverMap observerMap = viewModelObservers.get(viewModel);
-
+ public void publish(Object channel, String messageName, Object[] payload) {
+ if (channelObserverMap.containsKey(channel)) {
+ final ObserverMap observerMap = channelObserverMap.get(channel);
+
if (Platform.isFxApplicationThread()) {
publish(messageName, payload, observerMap);
} else {
try {
Platform.runLater(() -> publish(messageName, payload, observerMap));
- } catch(IllegalStateException e) {
+ } catch (IllegalStateException e) {
// If the toolkit isn't initialized yet we will publish the notification directly.
// In most cases this means that we are in a unit test and not JavaFX application is running.
- if(e.getMessage().equals("Toolkit not initialized")) {
+ if (e.getMessage().equals("Toolkit not initialized")) {
publish(messageName, payload, observerMap);
} else {
throw e;
@@ -94,31 +88,31 @@ public void publish(ViewModel viewModel, String messageName, Object[] payload) {
}
}
}
-
-
+
+
@Override
- public void subscribe(ViewModel viewModel, String messageName, NotificationObserver observer) {
- if(!viewModelObservers.containsKey(viewModel)) {
- viewModelObservers.put(viewModel, new ObserverMap());
+ public void subscribe(Object channel, String messageName, NotificationObserver observer) {
+ if (!channelObserverMap.containsKey(channel)) {
+ channelObserverMap.put(channel, new ObserverMap());
}
-
- final ObserverMap observerMap = viewModelObservers.get(viewModel);
+
+ final ObserverMap observerMap = channelObserverMap.get(channel);
addObserver(messageName, observer, observerMap);
}
-
+
@Override
- public void unsubscribe(ViewModel viewModel, String messageName, NotificationObserver observer) {
- if(viewModelObservers.containsKey(viewModel)) {
- final ObserverMap observerMap = viewModelObservers.get(viewModel);
+ public void unsubscribe(Object channel, String messageName, NotificationObserver observer) {
+ if (channelObserverMap.containsKey(channel)) {
+ final ObserverMap observerMap = channelObserverMap.get(channel);
removeObserversForMessageName(messageName, observer, observerMap);
}
}
-
-
+
+
@Override
- public void unsubscribe(ViewModel viewModel, NotificationObserver observer) {
- if(viewModelObservers.containsKey(viewModel)){
- ObserverMap observerMap = viewModelObservers.get(viewModel);
+ public void unsubscribe(Object channel, NotificationObserver observer) {
+ if (channelObserverMap.containsKey(channel)) {
+ ObserverMap observerMap = channelObserverMap.get(channel);
removeObserverFromObserverMap(observer, observerMap);
}
}
@@ -126,64 +120,81 @@ public void unsubscribe(ViewModel viewModel, NotificationObserver observer) {
/*
* Helper
*/
-
- private void publish(String messageName, Object[] payload, ObserverMap observerMap) {
+
+ private static void publish(String messageName, Object[] payload, ObserverMap observerMap) {
Collection notificationReceivers = observerMap.get(messageName);
if (notificationReceivers != null) {
-
+
// make a copy to prevent ConcurrentModificationException if inside of an observer a new observer is subscribed.
- final Collection copy = new ArrayList<>(notificationReceivers);
-
- for (NotificationObserver observer : copy) {
+
+ for (NotificationObserver observer : notificationReceivers) {
observer.receivedNotification(messageName, payload);
}
}
}
-
- private void addObserver(String messageName, NotificationObserver observer, ObserverMap observerMap) {
- if(!observerMap.containsKey(messageName)) {
- observerMap.put(messageName, new ArrayList<>());
+
+ private static void addObserver(String messageName, NotificationObserver observer, ObserverMap observerMap) {
+ if (!observerMap.containsKey(messageName)) {
+ // use CopyOnWriteArrayList to prevent ConcurrentModificationException if inside of an observer a new observer is subscribed.
+ observerMap.put(messageName, new CopyOnWriteArrayList<>());
}
-
+
final List observers = observerMap.get(messageName);
-
- if(observers.contains(observer)) {
- LOG.warn("Subscribe the observer ["+ observer + "] for the message [" + messageName +
- "], but the same observer was already added for this message in the past.");
+
+ if (observers.contains(observer)) {
+ LOG.warn("Subscribe the observer [" + observer + "] for the message [" + messageName +
+ "], but the same observer was already added for this message in the past.");
}
observers.add(observer);
}
-
-
-
- private void removeObserverFromObserverMap(NotificationObserver observer, ObserverMap observerMap) {
+
+
+ private static void removeObserverFromObserverMap(NotificationObserver observer, ObserverMap observerMap) {
for (String key : observerMap.keySet()) {
final List observers = observerMap.get(key);
-
- observers.removeIf(actualObserver -> actualObserver.equals(observer));
+
+ removeObserverFromObserverList(observer, observers);
}
}
-
- private void removeObserversForMessageName(String messageName, NotificationObserver observer,
- ObserverMap observerMap) {
-
- if(observerMap.containsKey(messageName)) {
+
+ private static void removeObserverFromObserverList(NotificationObserver observer, List observerList) {
+ observerList.removeIf(actualObserver -> actualObserver.equals(observer));
+
+ observerList.removeIf(actualObserver -> {
+ if(actualObserver instanceof WeakNotificationObserver) {
+ WeakNotificationObserver weakObserver = (WeakNotificationObserver) actualObserver;
+
+ NotificationObserver wrappedObserver = weakObserver.getWrappedObserver();
+
+ if(wrappedObserver == null) { // if reference was GCed we can remove the weakObserver
+ return true;
+ } else {
+ return wrappedObserver.equals(observer);
+ }
+ }
+
+ return false;
+ });
+ }
+
+ private static void removeObserversForMessageName(String messageName, NotificationObserver observer,
+ ObserverMap observerMap) {
+
+ if (observerMap.containsKey(messageName)) {
final List observers = observerMap.get(messageName);
- observers.removeIf(actualObserver -> actualObserver.equals(observer));
+ removeObserverFromObserverList(observer, observers);
+
if (observers.size() == 0) {
observerMap.remove(messageName);
}
}
}
-
+
@SuppressWarnings("serial")
private class ObserverMap extends HashMap> {
}
-
+
@SuppressWarnings("serial")
- private class ViewModelObservers extends HashMap {
+ private class ChannelObserverMap extends HashMap {
}
-
-
-
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationCenter.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationCenter.java
index 3d50d0509..ed571dc59 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationCenter.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationCenter.java
@@ -15,9 +15,6 @@
******************************************************************************/
package de.saxsys.mvvmfx.utils.notifications;
-import de.saxsys.mvvmfx.ViewModel;
-
-
/**
* Central component to provide a notification mechanism. You can add observers by using keys to get notifications for
* it. If you want you can pass an
@@ -85,45 +82,51 @@ void unsubscribe(String messageName,
/**
- * Publishes a notification to the {@link ViewModel}-subscribers for the given notificationId.
- *
+ * Publishes a notification on a specific channel. The channel can be any object that can be distinguished by the equals method.
+ * Only subscribers that use the same channel object can receive the published message.
+ *
+ * @param channel
+ * a channel object.
+ *
* @param messageName
* of the notification
* @param payload
* to be send
*/
- void publish(ViewModel viewModel, String messageName, Object[] payload);
+ void publish(Object channel, String messageName, Object[] payload);
/**
- * Subscribe to a {@link ViewModel}-notification with a given {@link NotificationObserver}.
+ *
+ * Subscribe to a notification with a given {@link NotificationObserver} on a specific channel.
+ * See {@link #publish(Object, String, Object[])} for more information on channels.
*
- * @param viewModel
+ * @param channel a channel object
*
* @param messageName
* of the Notification
* @param observer
* which should execute when the notification occurs
*/
- void subscribe(ViewModel viewModel, String messageName,
+ void subscribe(Object channel, String messageName,
NotificationObserver observer);
/**
* Removes a {@link NotificationObserver} for a given messageName.
*
- * @param viewModel
+ * @param channel
* @param messageName
* @param observer
*/
- void unsubscribe(ViewModel viewModel, String messageName,
+ void unsubscribe(Object channel, String messageName,
NotificationObserver observer);
/**
* Removes a {@link NotificationObserver} for all messageName.
*
- * @param viewModel
+ * @param channel
* @param observer
*/
- void unsubscribe(ViewModel viewModel,
+ void unsubscribe(Object channel,
NotificationObserver observer);
}
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationTestHelper.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationTestHelper.java
index 513274ebd..a911aa50c 100644
--- a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationTestHelper.java
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/NotificationTestHelper.java
@@ -1,3 +1,18 @@
+/*******************************************************************************
+ * Copyright 2015 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
package de.saxsys.mvvmfx.utils.notifications;
import de.saxsys.mvvmfx.ViewModel;
diff --git a/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/WeakNotificationObserver.java b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/WeakNotificationObserver.java
new file mode 100644
index 000000000..cd13a66d5
--- /dev/null
+++ b/mvvmfx/src/main/java/de/saxsys/mvvmfx/utils/notifications/WeakNotificationObserver.java
@@ -0,0 +1,104 @@
+/*******************************************************************************
+ * Copyright 2016 Alexander Casall, Manuel Mauky
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+package de.saxsys.mvvmfx.utils.notifications;
+
+import java.lang.ref.Reference;
+import java.lang.ref.WeakReference;
+import java.util.Objects;
+
+
+/**
+ *
+ * This class is a wrapper of a {@link NotificationObserver} that only
+ * holds a weak reference to the observer.
+ *
+ * When using normal {@link NotificationObserver} in combination with the global {@link NotificationObserver}
+ * the notification center will hold a reference to the observer as long as it isn't unregistered.
+ * The observer itself will most likely hold a reference to the parent class which can prevent
+ * the parent class from being garbage collected.
+ * In many use cases this is not a problem but in some situations this can cause memory leaks.
+ *
+ *
+ *
+ * For such situations this class can be used as a Wrapper around the normal notification observer.
+ * The usage should look like this:
+ *
+ *
+ *
+ * public class MyClass {
+ *
+ * private NotificationObserver observer;
+ *
+ * ...
+ *
+ * public void someMethod() {
+ * observer = (key, payload) -> {
+ * // do something when observer is called.
+ *
+ * };
+ *
+ * notificationCenter.subscribe("some_topic", new WeakNotificationObserver(observer));
+ * }
+ * }
+ *
+ *
+ * The example shows the following steps:
+ *
+ *