Add javadoc to Observable(List|Set)(Tree)?ContentProvider.dispose() explaining that observable content providers become unusable on disposal.
diff --git a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListContentProvider.java b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListContentProvider.java
index 188dd07..2345369 100644
--- a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListContentProvider.java
+++ b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListContentProvider.java
@@ -58,9 +58,8 @@
}
protected void checkInput(Object input) {
- Assert
- .isTrue(input instanceof IObservableList,
- "This content provider only works with input of type IObservableList"); //$NON-NLS-1$
+ Assert.isTrue(input instanceof IObservableList,
+ "This content provider only works with input of type IObservableList"); //$NON-NLS-1$
}
protected void addCollectionChangeListener(
@@ -175,6 +174,18 @@
return impl.getElements(inputElement);
}
+ /**
+ * Disposes of this content provider. This is called by the viewer when a
+ * content provider is replaced, or when the viewer itself is disposed.
+ * <p>
+ * The viewer should not be updated during this call, as it is in the
+ * process of being disposed.
+ * </p>
+ * <p>
+ * <em>Note:</em> Data binding content providers become unusable on
+ * disposal.
+ * </p>
+ */
public void dispose() {
impl.dispose();
}
diff --git a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListTreeContentProvider.java b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListTreeContentProvider.java
index b79296a..fc94004 100644
--- a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListTreeContentProvider.java
+++ b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableListTreeContentProvider.java
@@ -219,6 +219,18 @@
return impl.getParent(element);
}
+ /**
+ * Disposes of this content provider. This is called by the viewer when a
+ * content provider is replaced, or when the viewer itself is disposed.
+ * <p>
+ * The viewer should not be updated during this call, as it is in the
+ * process of being disposed.
+ * </p>
+ * <p>
+ * <em>Note:</em> Data binding content providers become unusable on
+ * disposal.
+ * </p>
+ */
public void dispose() {
impl.dispose();
}
diff --git a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetContentProvider.java b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetContentProvider.java
index 4f67c85..3240eb2 100644
--- a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetContentProvider.java
+++ b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetContentProvider.java
@@ -45,9 +45,8 @@
}
protected void checkInput(Object input) {
- Assert
- .isTrue(input instanceof IObservableSet,
- "This content provider only works with input of type IObservableSet"); //$NON-NLS-1$
+ Assert.isTrue(input instanceof IObservableSet,
+ "This content provider only works with input of type IObservableSet"); //$NON-NLS-1$
}
protected void addCollectionChangeListener(
@@ -109,6 +108,18 @@
return impl.getElements(inputElement);
}
+ /**
+ * Disposes of this content provider. This is called by the viewer when a
+ * content provider is replaced, or when the viewer itself is disposed.
+ * <p>
+ * The viewer should not be updated during this call, as it is in the
+ * process of being disposed.
+ * </p>
+ * <p>
+ * <em>Note:</em> Data binding content providers become unusable on
+ * disposal.
+ * </p>
+ */
public void dispose() {
impl.dispose();
}
diff --git a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetTreeContentProvider.java b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetTreeContentProvider.java
index 593aa2c..2ca876c 100644
--- a/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetTreeContentProvider.java
+++ b/bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/viewers/ObservableSetTreeContentProvider.java
@@ -159,6 +159,18 @@
return impl.getParent(element);
}
+ /**
+ * Disposes of this content provider. This is called by the viewer when a
+ * content provider is replaced, or when the viewer itself is disposed.
+ * <p>
+ * The viewer should not be updated during this call, as it is in the
+ * process of being disposed.
+ * </p>
+ * <p>
+ * <em>Note:</em> Data binding content providers become unusable on
+ * disposal.
+ * </p>
+ */
public void dispose() {
impl.dispose();
}
