diff options
| author | Tom Schindl | 2014-03-25 18:30:57 +0000 |
|---|---|---|
| committer | Tom Schindl | 2014-03-25 18:30:57 +0000 |
| commit | 76c887d98c3df7b33dd108e26740f5f7bf3b0106 (patch) | |
| tree | 7355479aa5cef09c6397a4230a2799514f681140 /bundles/runtime/org.eclipse.fx.ui.di/src/org/eclipse/fx | |
| parent | 05010d3a3bccb1bb36f2090b57d7e70434e6a97b (diff) | |
| download | org.eclipse.efxclipse-76c887d98c3df7b33dd108e26740f5f7bf3b0106.tar.gz org.eclipse.efxclipse-76c887d98c3df7b33dd108e26740f5f7bf3b0106.tar.xz org.eclipse.efxclipse-76c887d98c3df7b33dd108e26740f5f7bf3b0106.zip | |
fixed javadoc
Diffstat (limited to 'bundles/runtime/org.eclipse.fx.ui.di/src/org/eclipse/fx')
| -rwxr-xr-x | bundles/runtime/org.eclipse.fx.ui.di/src/org/eclipse/fx/ui/di/FXMLBuilder.java | 67 |
1 files changed, 63 insertions, 4 deletions
diff --git a/bundles/runtime/org.eclipse.fx.ui.di/src/org/eclipse/fx/ui/di/FXMLBuilder.java b/bundles/runtime/org.eclipse.fx.ui.di/src/org/eclipse/fx/ui/di/FXMLBuilder.java index 8fa9585f3..b070bf6f3 100755 --- a/bundles/runtime/org.eclipse.fx.ui.di/src/org/eclipse/fx/ui/di/FXMLBuilder.java +++ b/bundles/runtime/org.eclipse.fx.ui.di/src/org/eclipse/fx/ui/di/FXMLBuilder.java @@ -13,16 +13,75 @@ package org.eclipse.fx.ui.di; import java.io.IOException;
import java.util.ResourceBundle;
+import org.eclipse.jdt.annotation.NonNull;
+
import javafx.util.BuilderFactory;
+/**
+ * Builder for an FXMLLoader
+ *
+ * @param <N>
+ * the root type loaded by the builder
+ */
public interface FXMLBuilder<N> {
- FXMLBuilder<N> resourceBundle(ResourceBundle resourceBundle);
+ /**
+ * Associate a resource bundle with the loader
+ *
+ * @param resourceBundle
+ * the resource bundle
+ * @return the builder instance
+ */
+ @NonNull
+ FXMLBuilder<N> resourceBundle(@NonNull ResourceBundle resourceBundle);
+
+ /**
+ * Associate a builder factory with the loader
+ *
+ * @param builderFactory
+ * the builder factory
+ * @return the builder instance
+ */
+ @NonNull
FXMLBuilder<N> builderFactory(BuilderFactory builderFactory);
+
+ /**
+ * Load the FXML-Document
+ *
+ * @return the root node
+ * @throws IOException
+ * if there is a problem loading the fxml
+ */
+ @NonNull
N load() throws IOException;
- <C> Data loadWithController() throws IOException;
-
- interface Data<N,C> {
+
+ /**
+ * Load the FXML and return the root node and the controller
+ *
+ * @return a structure holding root node and controller
+ * @throws IOException
+ * if there is a problem loading the fxml
+ */
+ <C> Data<C, N> loadWithController() throws IOException;
+
+ /**
+ * Data struct holing root node and controller
+ *
+ * @param <N>
+ * the root node type
+ * @param <C>
+ * the controller type
+ */
+ public interface Data<N, C> {
+ /**
+ * @return the root node
+ */
+ @NonNull
public N getNode();
+
+ /**
+ * @return the controller, might be <code>null</code> if the fxml is not
+ * associated to a controller
+ */
public C getController();
}
}
|