Renamed 'Nesting.innerObservable' to 'Nesting.innerObservableProperty'.

Nicolai Parlog · Nicolai Parlog · commit e106834db63c · 2014-07-04T20:50:22.000+02:00
diff --git a/src/org/codefx/libfx/nesting/DeepNesting.java b/src/org/codefx/libfx/nesting/DeepNesting.java
@@ -13,7 +13,7 @@
 
 /**
  * An implementation of {@link Nesting} which uses an outer {@link ObservableValue} and a series of nesting steps to get
- * the {@link #innerObservable()}.
+ * the {@link #innerObservableProperty() innerObservable}.
  *
  * @param <O>
  *            the hierarchy's innermost type of {@link Observable}
@@ -188,7 +188,7 @@ private void updateNestingFromLevel(int startLevel) {
 	 * {@inheritDoc}
 	 */
 	@Override
-	public ReadOnlyProperty<Optional<O>> innerObservable() {
+	public ReadOnlyProperty<Optional<O>> innerObservableProperty() {
 		return inner;
 	}
 
diff --git a/src/org/codefx/libfx/nesting/Nesting.java b/src/org/codefx/libfx/nesting/Nesting.java
@@ -7,9 +7,10 @@
 import javafx.beans.value.ObservableValue;
 
 /**
- * A nesting encapsulates a hierarchy of nested {@link ObservableValue ObservableValues}; its {@link #innerObservable()}
- * always contains the current innermost {@link Observable} in that hierarchy as an {@link Optional}. If some observable
- * or its value were null, {@code innerObservable} contains {@link Optional#empty()}.
+ * A nesting encapsulates a hierarchy of nested {@link ObservableValue ObservableValues}; its
+ * {@link #innerObservableProperty() innerObservable} property always contains the current innermost {@link Observable}
+ * in that hierarchy as an {@link Optional}. If some observable or its value were null, {@code innerObservableProperty}
+ * contains {@link Optional#empty()}.
  * <p>
  * Nestings will usually be implemented such that they eagerly evaluate the nested observables.
  *
@@ -19,11 +20,11 @@
 public interface Nesting<O extends Observable> {
 
 	/**
-	 * A property holding the current innermost observable in the hierarchy. If some observable or its value were null,
-	 * this contains {@link Optional#empty()}.
+	 * A property holding the current innermost observable in the hierarchy as an optional. If some observable or its
+	 * value were null, this contains {@link Optional#empty()}.
 	 *
 	 * @return the innermost {@link ObservableValue} in an {@link Optional}
 	 */
-	ReadOnlyProperty<Optional<O>> innerObservable();
+	ReadOnlyProperty<Optional<O>> innerObservableProperty();
 
 }
diff --git a/src/org/codefx/libfx/nesting/ShallowNesting.java b/src/org/codefx/libfx/nesting/ShallowNesting.java
@@ -35,7 +35,7 @@ public ShallowNesting(O outerObservable) {
 	}
 
 	@Override
-	public ReadOnlyProperty<Optional<O>> innerObservable() {
+	public ReadOnlyProperty<Optional<O>> innerObservableProperty() {
 		return inner;
 	}
 
diff --git a/src/org/codefx/libfx/nesting/property/NestedBooleanPropertyBuilder.java b/src/org/codefx/libfx/nesting/property/NestedBooleanPropertyBuilder.java
@@ -5,7 +5,7 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * A builder for a {@link NestedBooleanProperty} which is bound to the {@link Nesting#innerObservable() innerObservable}
+ * A builder for a {@link NestedBooleanProperty} which is bound to the {@link Nesting#innerObservableProperty() innerObservable}
  * of a {@link Nesting}.
  */
 public class NestedBooleanPropertyBuilder extends AbstractNestedPropertyBuilder<BooleanProperty, NestedBooleanProperty> {
diff --git a/src/org/codefx/libfx/nesting/property/NestedDoublePropertyBuilder.java b/src/org/codefx/libfx/nesting/property/NestedDoublePropertyBuilder.java
@@ -5,7 +5,7 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * A builder for a {@link NestedDoubleProperty} which is bound to the {@link Nesting#innerObservable() innerObservable}
+ * A builder for a {@link NestedDoubleProperty} which is bound to the {@link Nesting#innerObservableProperty() innerObservable}
  * of a {@link Nesting}.
  */
 public class NestedDoublePropertyBuilder extends AbstractNestedPropertyBuilder<DoubleProperty, NestedDoubleProperty> {
diff --git a/src/org/codefx/libfx/nesting/property/NestedFloatPropertyBuilder.java b/src/org/codefx/libfx/nesting/property/NestedFloatPropertyBuilder.java
@@ -5,7 +5,7 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * A builder for a {@link NestedFloatProperty} which is bound to the {@link Nesting#innerObservable() innerObservable}
+ * A builder for a {@link NestedFloatProperty} which is bound to the {@link Nesting#innerObservableProperty() innerObservable}
  * of a {@link Nesting}.
  */
 public class NestedFloatPropertyBuilder extends AbstractNestedPropertyBuilder<FloatProperty, NestedFloatProperty> {
diff --git a/src/org/codefx/libfx/nesting/property/NestedIntegerPropertyBuilder.java b/src/org/codefx/libfx/nesting/property/NestedIntegerPropertyBuilder.java
@@ -5,7 +5,7 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * A builder for a {@link NestedIntegerProperty} which is bound to the {@link Nesting#innerObservable() innerObservable}
+ * A builder for a {@link NestedIntegerProperty} which is bound to the {@link Nesting#innerObservableProperty() innerObservable}
  * of a {@link Nesting}.
  */
 public class NestedIntegerPropertyBuilder extends AbstractNestedPropertyBuilder<IntegerProperty, NestedIntegerProperty> {
diff --git a/src/org/codefx/libfx/nesting/property/NestedLongPropertyBuilder.java b/src/org/codefx/libfx/nesting/property/NestedLongPropertyBuilder.java
@@ -5,7 +5,7 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * A builder for a {@link NestedLongProperty} which is bound to the {@link Nesting#innerObservable() innerObservable} of
+ * A builder for a {@link NestedLongProperty} which is bound to the {@link Nesting#innerObservableProperty() innerObservable} of
  * a {@link Nesting}.
  */
 public class NestedLongPropertyBuilder extends AbstractNestedPropertyBuilder<LongProperty, NestedLongProperty> {
diff --git a/src/org/codefx/libfx/nesting/property/NestedObjectPropertyBuilder.java b/src/org/codefx/libfx/nesting/property/NestedObjectPropertyBuilder.java
@@ -5,7 +5,7 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * A builder for a {@link Property} which is bound to the {@link Nesting#innerObservable() innerObservable} of a
+ * A builder for a {@link Property} which is bound to the {@link Nesting#innerObservableProperty() innerObservable} of a
  * {@link Nesting}.
  *
  * @param <T>
diff --git a/src/org/codefx/libfx/nesting/property/NestedStringPropertyBuilder.java b/src/org/codefx/libfx/nesting/property/NestedStringPropertyBuilder.java
@@ -5,7 +5,7 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * A builder for a {@link NestedStringProperty} which is bound to the {@link Nesting#innerObservable() innerObservable}
+ * A builder for a {@link NestedStringProperty} which is bound to the {@link Nesting#innerObservableProperty() innerObservable}
  * of a {@link Nesting}.
  */
 public class NestedStringPropertyBuilder extends AbstractNestedPropertyBuilder<StringProperty, NestedStringProperty> {
diff --git a/src/org/codefx/libfx/nesting/property/PropertyToNestingBinding.java b/src/org/codefx/libfx/nesting/property/PropertyToNestingBinding.java
@@ -9,8 +9,8 @@
 import org.codefx.libfx.nesting.Nesting;
 
 /**
- * Implements the bidirectional binding between a nested property and its nesting's {@link Nesting#innerObservable()
- * innerProperty} and updates the binding when the nesting changes.
+ * Implements the bidirectional binding between a nested property and its nesting's
+ * {@link Nesting#innerObservableProperty() innerObservable} and updates the binding when the nesting changes.
  *
  * @param <T>
  *            the type wrapped by the property
@@ -101,9 +101,9 @@ public static <T> void bind(
 	 */
 	private void bindToNestingProperty() {
 		// bind to the nesting's current property
-		moveBinding(Optional.empty(), nesting.innerObservable().getValue());
+		moveBinding(Optional.empty(), nesting.innerObservableProperty().getValue());
 		// add a listener to the nesting which moves the binding from one property to the next
-		nesting.innerObservable().addListener(
+		nesting.innerObservableProperty().addListener(
 				(observable, oldProperty, newProperty) -> moveBinding(oldProperty, newProperty));
 	}
 
@@ -117,7 +117,7 @@ private void bindToNestingProperty() {
 	 */
 	private void moveBinding(
 			Optional<? extends Property<T>> oldPropertyOpt,
-			Optional<? extends Property<T>> newPropertyOpt) {
+					Optional<? extends Property<T>> newPropertyOpt) {
 
 		oldPropertyOpt.ifPresent(oldProperty -> nestedProperty.unbindBidirectional(oldProperty));
 		newPropertyOpt.ifPresent(newProperty -> nestedProperty.bindBidirectional(newProperty));
diff --git a/test/org/codefx/libfx/nesting/AbstractDeepNestingTest.java b/test/org/codefx/libfx/nesting/AbstractDeepNestingTest.java
@@ -25,7 +25,7 @@ public abstract class AbstractDeepNestingTest<OO extends Observable, IO extends
 	// nested value
 
 	/**
-	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservable() innerObservable} is updated correctly when
+	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservableProperty() innerObservable} is updated correctly when
 	 * one of the {@link #outerObservable}'s nested values is changed.
 	 */
 	@Test
@@ -35,7 +35,7 @@ public void testWhenSettingNestedValue() {
 	}
 
 	/**
-	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservable() innerObservable} is updated correctly when
+	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservableProperty() innerObservable} is updated correctly when
 	 * one of the {@link #outerObservable}'s nested values is changed to one which contains null observables.
 	 */
 	@Test
@@ -45,7 +45,7 @@ public void testWhenSettingNestedValueWithNullObservables() {
 	}
 
 	/**
-	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservable() innerObservable} is updated correctly when
+	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservableProperty() innerObservable} is updated correctly when
 	 * one of the {@link #outerObservable}'s nested values is set to null.
 	 */
 	@Test
@@ -57,7 +57,7 @@ public void testWhenSettingNestedValueToNull() {
 	// outer value
 
 	/**
-	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservable() innerObservable} is updated correctly when
+	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservableProperty() innerObservable} is updated correctly when
 	 * the {@link #outerObservable}'s outer value is changed.
 	 */
 	@Test
@@ -67,7 +67,7 @@ public void testWhenSettingOuterValue() {
 	}
 
 	/**
-	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservable() innerObservable} is updated correctly when
+	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservableProperty() innerObservable} is updated correctly when
 	 * the {@link #outerObservable}'s outer value is changed to one which contains null observables.
 	 */
 	@Test
@@ -77,7 +77,7 @@ public void testWhenSettingOuterValueWithNullObservables() {
 	}
 
 	/**
-	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservable() innerObservable} is updated correctly when
+	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservableProperty() innerObservable} is updated correctly when
 	 * the {@link #outerObservable}'s outer value is set to null.
 	 */
 	@Test
diff --git a/test/org/codefx/libfx/nesting/AbstractNestingTest.java b/test/org/codefx/libfx/nesting/AbstractNestingTest.java
@@ -45,8 +45,8 @@ public void setUp() {
 	// #region TESTS
 
 	/**
-	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservable() innerObservable} property contains the
-	 * {@link #outerObservable}'s inner observable.
+	 * Tests whether the {@link #nesting}'s {@link Nesting#innerObservableProperty() innerObservable} property contains
+	 * the correct observable, which is the {@link #outerObservable}'s inner observable.
 	 */
 	@Test
 	public void testCorrectAfterConstruction() {
diff --git a/test/org/codefx/libfx/nesting/testhelper/NestingAccess.java b/test/org/codefx/libfx/nesting/testhelper/NestingAccess.java
@@ -14,7 +14,8 @@
 
 /**
  * Provides simple usability functions to access an outer observable's nesting hierarchy in a more readable way. To that
- * end, many arguments and return types can be null (see method comments).
+ * end, many arguments and return types can be null if the {@link Nesting#innerObservableProperty() innerObservable} is
+ * not present.(see method comments)
  */
 public class NestingAccess {
 
@@ -25,13 +26,14 @@ public class NestingAccess {
 	 *            the type of observable the nesting contains
 	 * @param nesting
 	 *            the nesting whose observable will be returned
-	 * @return {@link Nesting#innerObservable()}.{@link ReadOnlyProperty#getValue() getValue()}.{@link Optional#get()
-	 *         get()}; can be null
+	 * @return the observable in the nesting's {@code innerObservable} property:
+	 *         {@link Nesting#innerObservableProperty()}.{@link ReadOnlyProperty#getValue() getValue()}.
+	 *         {@link Optional#get() get()}; will be null if no observable is present
 	 */
 	public static <O extends Observable> O getNestingObservable(Nesting<O> nesting) {
 		Objects.requireNonNull(nesting, "The argument 'nesting' must not be null.");
 
-		Optional<O> nestingObservable = nesting.innerObservable().getValue();
+		Optional<O> nestingObservable = nesting.innerObservableProperty().getValue();
 		if (nestingObservable.isPresent())
 			return nestingObservable.get();
 		else
@@ -61,9 +63,11 @@ public static <O extends Observable> void setNestingObservable(EditableNesting<O
 	 *            the type of observable the nesting contains
 	 * @param nesting
 	 *            the nesting whose observable's value will be returned
-	 * @return the value of the observable in {@link Nesting#innerObservable()}; can be null
+	 * @return the value of the observable in the nesting's {@code innerObservable} property:
+	 *         {@link Nesting#innerObservableProperty()}.{@link ReadOnlyProperty#getValue() getValue()}.
+	 *         {@link Optional#get() get()}.{@link ObservableValue#getValue() getValue()}; can be null
 	 * @throws NullPointerException
-	 *             if the nesting's inner observable is null
+	 *             if the nesting's inner observable is not present
 	 */
 	public static <T, O extends ObservableValue<T>> T getNestingValue(Nesting<O> nesting) {
 		Objects.requireNonNull(nesting, "The argument 'nesting' must not be null.");
@@ -83,7 +87,7 @@ public static <T, O extends ObservableValue<T>> T getNestingValue(Nesting<O> nes
 	 * @param newValue
 	 *            the nesting's observable's new value; can be null.
 	 * @throws NullPointerException
-	 *             if the nesting's inner observable is null
+	 *             if the nesting's inner observable is not present
 	 */
 	public static <T, O extends Property<T>> void setNestingValue(Nesting<O> nesting, T newValue) {
 		Objects.requireNonNull(nesting, "The argument 'nesting' must not be null.");
@@ -192,7 +196,7 @@ public static IntegerProperty getInnerIntegerProperty(ObservableValue<OuterValue
 
 	/**
 	 * An implementation of {@link Nesting} which does no real nesting. Instead it allows to directly edit the
-	 * {@link Nesting#innerObservable()}.
+	 * {@link Nesting#innerObservableProperty()}.
 	 *
 	 * @param <O>
 	 *            the type of the inner observable
@@ -246,7 +250,7 @@ public static <O extends Observable> EditableNesting<O> createWithInnerObservabl
 		 * @return the innerObservable as a property
 		 */
 		@Override
-		public Property<Optional<O>> innerObservable() {
+		public Property<Optional<O>> innerObservableProperty() {
 			return innerObservable;
 		}
 
@@ -256,7 +260,7 @@ public Property<Optional<O>> innerObservable() {
 		 * @return the innerObservable
 		 */
 		public Optional<O> getInnerObservable() {
-			return innerObservable().getValue();
+			return innerObservableProperty().getValue();
 		}
 
 		/**
@@ -266,7 +270,7 @@ public Optional<O> getInnerObservable() {
 		 *            the innerObservable to set
 		 */
 		public void setInnerObservable(Optional<O> innerObservable) {
-			innerObservable().setValue(innerObservable);
+			innerObservableProperty().setValue(innerObservable);
 		}
 
 	}

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public ShallowNesting(O outerObservable) {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`@Override`
`38`		`- public ReadOnlyProperty<Optional<O>> innerObservable() {`
	`38`	`+ public ReadOnlyProperty<Optional<O>> innerObservableProperty() {`
`39`	`39`	`return inner;`
`40`	`40`	`}`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`import org.codefx.libfx.nesting.Nesting;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * A builder for a {@link Property} which is bound to the {@link Nesting#innerObservable() innerObservable} of a`
	`8`	`+ * A builder for a {@link Property} which is bound to the {@link Nesting#innerObservableProperty() innerObservable} of a`
`9`	`9`	`* {@link Nesting}.`
`10`	`10`	`*`
`11`	`11`	`* @param <T>`