brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henev...@apache.org
Subject [03/13] git commit: Mark getRebindSupport() as @Beta
Date Fri, 24 Oct 2014 11:54:28 GMT
Mark getRebindSupport() as @Beta

- adds comment that this code should never be called or implemented
  directly by a user, and that it may change or be deleted in
  future versions without notice.


Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/3ec342bc
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/3ec342bc
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/3ec342bc

Branch: refs/heads/master
Commit: 3ec342bc2a92472e6279a59c97f9c8b6d53e503a
Parents: 2e84f3f
Author: Aled Sage <aled.sage@gmail.com>
Authored: Thu Oct 23 12:55:57 2014 +0100
Committer: Aled Sage <aled.sage@gmail.com>
Committed: Thu Oct 23 13:57:09 2014 +0100

----------------------------------------------------------------------
 api/src/main/java/brooklyn/entity/Feed.java                   | 5 ++++-
 api/src/main/java/brooklyn/entity/rebind/Rebindable.java      | 7 +++++++
 api/src/main/java/brooklyn/policy/Enricher.java               | 6 ++++++
 api/src/main/java/brooklyn/policy/Policy.java                 | 6 ++++++
 core/src/main/java/brooklyn/entity/basic/AbstractEntity.java  | 7 +++++++
 core/src/main/java/brooklyn/entity/basic/EntityInternal.java  | 6 ++++++
 .../main/java/brooklyn/location/basic/LocationInternal.java   | 6 ++++++
 7 files changed, 42 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3ec342bc/api/src/main/java/brooklyn/entity/Feed.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/brooklyn/entity/Feed.java b/api/src/main/java/brooklyn/entity/Feed.java
index 390b01f..10d1fbd 100644
--- a/api/src/main/java/brooklyn/entity/Feed.java
+++ b/api/src/main/java/brooklyn/entity/Feed.java
@@ -65,8 +65,11 @@ public interface Feed extends EntityAdjunct, Rebindable {
     void stop();
 
     /**
-     * This method will likely move out of this interface, into somewhere internal; users
should not call this directly.  
+     * Users are strongly discouraged from calling or overriding this method.
+     * It is for internal calls only, relating to persisting/rebinding entities.
+     * This method may change (or be removed) in a future release without notice.
      */
     @Override
+    @Beta
     RebindSupport<FeedMemento> getRebindSupport();
 }

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3ec342bc/api/src/main/java/brooklyn/entity/rebind/Rebindable.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/brooklyn/entity/rebind/Rebindable.java b/api/src/main/java/brooklyn/entity/rebind/Rebindable.java
index d1bc636..aa15f6a 100644
--- a/api/src/main/java/brooklyn/entity/rebind/Rebindable.java
+++ b/api/src/main/java/brooklyn/entity/rebind/Rebindable.java
@@ -20,12 +20,19 @@ package brooklyn.entity.rebind;
 
 import brooklyn.mementos.Memento;
 
+import com.google.common.annotations.Beta;
+
 /**
  * Indicates that this can be recreated, e.g. after a brooklyn restart, and by
  * using a {@link Memento} it can repopulate the brooklyn objects. The purpose
  * of the rebind is to reconstruct and reconnect the brooklyn objects, including
  * binding them to external resources.
+ * 
+ * Users are strongly discouraged to call or use this interface.
+ * It is for internal use only, relating to persisting/rebinding entities.
+ * This interface may change (or be removed) in a future release without notice.
  */
+@Beta
 public interface Rebindable {
 
     public RebindSupport getRebindSupport();

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3ec342bc/api/src/main/java/brooklyn/policy/Enricher.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/brooklyn/policy/Enricher.java b/api/src/main/java/brooklyn/policy/Enricher.java
index 53f2603..0d6e87a 100644
--- a/api/src/main/java/brooklyn/policy/Enricher.java
+++ b/api/src/main/java/brooklyn/policy/Enricher.java
@@ -62,7 +62,13 @@ public interface Enricher extends EntityAdjunct, Rebindable, Configurable
{
 
     Map<ConfigKey<?>, Object> getAllConfig();
 
+    /**
+     * Users are strongly discouraged from calling or overriding this method.
+     * It is for internal calls only, relating to persisting/rebinding entities.
+     * This method may change (or be removed) in a future release without notice.
+     */
     @Override
+    @Beta
     RebindSupport<EnricherMemento> getRebindSupport();
 
 }

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3ec342bc/api/src/main/java/brooklyn/policy/Policy.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/brooklyn/policy/Policy.java b/api/src/main/java/brooklyn/policy/Policy.java
index 3e275cf..cc1bfa9 100644
--- a/api/src/main/java/brooklyn/policy/Policy.java
+++ b/api/src/main/java/brooklyn/policy/Policy.java
@@ -77,6 +77,12 @@ public interface Policy extends EntityAdjunct, Rebindable, Configurable
{
     
     Map<ConfigKey<?>, Object> getAllConfig();
 
+    /**
+     * Users are strongly discouraged from calling or overriding this method.
+     * It is for internal calls only, relating to persisting/rebinding entities.
+     * This method may change (or be removed) in a future release without notice.
+     */
     @Override
+    @Beta
     RebindSupport<PolicyMemento> getRebindSupport();
 }

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3ec342bc/core/src/main/java/brooklyn/entity/basic/AbstractEntity.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/entity/basic/AbstractEntity.java b/core/src/main/java/brooklyn/entity/basic/AbstractEntity.java
index 2cb8b66..00b58b7 100644
--- a/core/src/main/java/brooklyn/entity/basic/AbstractEntity.java
+++ b/core/src/main/java/brooklyn/entity/basic/AbstractEntity.java
@@ -1433,7 +1433,14 @@ public abstract class AbstractEntity extends AbstractBrooklynObject
implements E
         getManagementSupport().getEntityChangeListener().onChanged();
     }
 
+    /**
+     * As described in {@link EntityInternal#getRebindSupport()}...
+     * Users are strongly discouraged to call or override this method.
+     * It is for internal calls only, relating to persisting/rebinding entities.
+     * This method may change (or be removed) in a future release without notice.
+     */
     @Override
+    @Beta
     public RebindSupport<EntityMemento> getRebindSupport() {
         return new BasicEntityRebindSupport(this);
     }

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3ec342bc/core/src/main/java/brooklyn/entity/basic/EntityInternal.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/entity/basic/EntityInternal.java b/core/src/main/java/brooklyn/entity/basic/EntityInternal.java
index 63d11be..56443a9 100644
--- a/core/src/main/java/brooklyn/entity/basic/EntityInternal.java
+++ b/core/src/main/java/brooklyn/entity/basic/EntityInternal.java
@@ -144,7 +144,13 @@ public interface EntityInternal extends BrooklynObjectInternal, EntityLocal,
Reb
 
     Map<String, String> toMetadataRecord();
     
+    /**
+     * Users are strongly discouraged from calling or overriding this method.
+     * It is for internal calls only, relating to persisting/rebinding entities.
+     * This method may change (or be removed) in a future release without notice.
+     */
     @Override
+    @Beta
     RebindSupport<EntityMemento> getRebindSupport();
 
     /**

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3ec342bc/core/src/main/java/brooklyn/location/basic/LocationInternal.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/location/basic/LocationInternal.java b/core/src/main/java/brooklyn/location/basic/LocationInternal.java
index a31b0c8..c4acbaa 100644
--- a/core/src/main/java/brooklyn/location/basic/LocationInternal.java
+++ b/core/src/main/java/brooklyn/location/basic/LocationInternal.java
@@ -67,7 +67,13 @@ public interface LocationInternal extends BrooklynObjectInternal, Location
{
 
     ConfigBag getAllConfigBag();
 
+    /**
+     * Users are strongly discouraged from calling or overriding this method.
+     * It is for internal calls only, relating to persisting/rebinding entities.
+     * This method may change (or be removed) in a future release without notice.
+     */
     @Override
+    @Beta
     RebindSupport<LocationMemento> getRebindSupport();
     
     ManagementContext getManagementContext();


Mime
View raw message