Merge branch 'master' of https://github.com/bculkin2442/bjc-utils2

1 files changed, 49 insertions, 0 deletions

diff --git a/base/src/main/java/bjc/utils/components/ComponentRepository.java b/base/src/main/java/bjc/utils/components/ComponentRepository.java
new file mode 100644
index 0000000..120edc8
--- /dev/null
+++ b/base/src/main/java/bjc/utils/components/ComponentRepository.java
@@ -0,0 +1,49 @@
+package bjc.utils.components;
+
+import bjc.funcdata.ListEx;
+import bjc.funcdata.MapEx;
+
+/**
+ * A collection of implementations of a particular type of
+ * {@link DescribedComponent}.
+ *
+ * @author ben
+ *
+ * @param <ComponentType>
+ *                        The type of components contained in this repository.
+ */
+public interface ComponentRepository<ComponentType extends DescribedComponent> {
+	/**
+	 * Get all of the components this repository knows about.
+	 *
+	 * @return A map from component name to component, containing all of the
+	 *         components in the repositories.
+	 */
+	public MapEx<String, ComponentType> getAll();
+
+	/**
+	 * Get a component with a specific name.
+	 *
+	 * @param name
+	 *             The name of the component to retrieve.
+	 *
+	 * @return The named component, or null if no component with that name exists.
+	 */
+	public ComponentType getByName(String name);
+
+	/**
+	 * Get a list of all the registered components.
+	 *
+	 * @return A list of all the registered components.
+	 */
+	public default ListEx<ComponentType> getList() {
+		return getAll().valueList();
+	}
+
+	/**
+	 * Get the source from which these components came.
+	 *
+	 * @return The source from which these components came.
+	 */
+	public String getSource();
+}