diff options
| author | Benjamin J. Culkin <bjculkin@mix.wvu.edu> | 2017-10-11 13:41:07 -0300 |
|---|---|---|
| committer | Benjamin J. Culkin <bjculkin@mix.wvu.edu> | 2017-10-11 13:41:07 -0300 |
| commit | 946cab444bc301d8a7c756a1bab039558288de89 (patch) | |
| tree | 419f27c39a509bcd83cae0e6630be8eb7ff95a30 /base/src/main/java/bjc/utils/components/IComponentRepository.java | |
| parent | c82e3b3b2de0633317ec8fc85925e91422820597 (diff) | |
Cleanup work
Diffstat (limited to 'base/src/main/java/bjc/utils/components/IComponentRepository.java')
| -rw-r--r-- | base/src/main/java/bjc/utils/components/IComponentRepository.java | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/base/src/main/java/bjc/utils/components/IComponentRepository.java b/base/src/main/java/bjc/utils/components/IComponentRepository.java index 6ee51f3..099693f 100644 --- a/base/src/main/java/bjc/utils/components/IComponentRepository.java +++ b/base/src/main/java/bjc/utils/components/IComponentRepository.java @@ -5,45 +5,49 @@ import bjc.utils.funcdata.IMap; /** * A collection of implementations of a particular type of - * {@link IDescribedComponent} + * {@link IDescribedComponent}. * * @author ben * * @param <ComponentType> - * The type of components contained in this repository + * The type of components contained in this repository. */ public interface IComponentRepository<ComponentType extends IDescribedComponent> { /** - * Get all of the components this repository knows about + * 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 + * @return + * A map from component name to component, containing all of the + * components in the repositories. */ public IMap<String, ComponentType> getAll(); /** - * Get a component with a specific name + * 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 + * 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 + * Get a list of all the registered components. * - * @return A list of all the registered components + * @return + * A list of all the registered components. */ public default IList<ComponentType> getList() { return getAll().valueList(); } /** - * Get the source from which these components came + * Get the source from which these components came. * - * @return The source from which these components came + * @return + * The source from which these components came. */ public String getSource(); -}
\ No newline at end of file +} |
