Update comments on catalogItemId().
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-server/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-server/commit/db2e23ff Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-server/tree/db2e23ff Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-server/diff/db2e23ff Branch: refs/heads/master Commit: db2e23ff74b08d4ebd4f54a30003f0c0a99248db Parents: 9b176a3 Author: Geoff Macartney <[email protected]> Authored: Tue Mar 21 12:06:51 2017 +0000 Committer: Geoff Macartney <[email protected]> Committed: Thu Apr 20 11:20:36 2017 +0100 ---------------------------------------------------------------------- .../brooklyn/api/internal/AbstractBrooklynObjectSpec.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/db2e23ff/api/src/main/java/org/apache/brooklyn/api/internal/AbstractBrooklynObjectSpec.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/brooklyn/api/internal/AbstractBrooklynObjectSpec.java b/api/src/main/java/org/apache/brooklyn/api/internal/AbstractBrooklynObjectSpec.java index 12a8e73..d88078a 100644 --- a/api/src/main/java/org/apache/brooklyn/api/internal/AbstractBrooklynObjectSpec.java +++ b/api/src/main/java/org/apache/brooklyn/api/internal/AbstractBrooklynObjectSpec.java @@ -103,17 +103,19 @@ public abstract class AbstractBrooklynObjectSpec<T, SpecT extends AbstractBrookl } /** - * Set the catalog item ID that defined this object, also used for searching for type and resources referenced + * Set the catalog item ID that defined this object; * since https://issues.apache.org/jira/browse/BROOKLYN-445 this must no longer be used to indicate * a caller-context catalog item that should be used for search purposes; - * if that behaviour is desired, the child should be refactored to be its own item in the catalog BOM - * (or TODO we add a separate field to record other catalog item IDs that could be applied for searching, see below) + * instead use {@link #catalogItemIdAndSearchPath}. */ public SpecT catalogItemId(String val) { catalogItemId = val; return self(); } + /** + * Set the immediate catalog item ID of this object, and the search path of other catalog items used to define it. + */ public synchronized SpecT catalogItemIdAndSearchPath(String catalogItemId, Collection<String> searchPath) { if (catalogItemId != null) { catalogItemId(catalogItemId);
