You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by sj...@apache.org on 2015/10/14 15:55:49 UTC
[03/17] incubator-brooklyn git commit: Javadoc improvements
Javadoc improvements
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/f0e0ba7e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/f0e0ba7e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/f0e0ba7e
Branch: refs/heads/master
Commit: f0e0ba7ea22b8465bba1a3e94d6ba1b5446ff322
Parents: 7b89b66
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Authored: Tue Aug 25 16:51:17 2015 +0100
Committer: Sam Corbett <sa...@cloudsoftcorp.com>
Committed: Thu Oct 8 11:10:31 2015 +0100
----------------------------------------------------------------------
.../org/apache/brooklyn/api/entity/Entity.java | 2 +-
.../brooklyn/core/entity/AbstractEntity.java | 2 +-
.../brooklyn/util/core/ResourceUtils.java | 23 +++++++++++++++-----
.../org/apache/brooklyn/config/ConfigKey.java | 4 ++--
4 files changed, 21 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/f0e0ba7e/api/src/main/java/org/apache/brooklyn/api/entity/Entity.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/brooklyn/api/entity/Entity.java b/api/src/main/java/org/apache/brooklyn/api/entity/Entity.java
index eb9f907..e01d5e2 100644
--- a/api/src/main/java/org/apache/brooklyn/api/entity/Entity.java
+++ b/api/src/main/java/org/apache/brooklyn/api/entity/Entity.java
@@ -265,7 +265,7 @@ public interface Entity extends BrooklynObject {
* @deprecated since 0.9.0; see {@link PolicySupport#add(PolicySpec)}
*/
@Deprecated
- <T extends Policy> T addPolicy(PolicySpec<T> enricher);
+ <T extends Policy> T addPolicy(PolicySpec<T> policy);
/**
* Removes the given policy from this entity.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/f0e0ba7e/core/src/main/java/org/apache/brooklyn/core/entity/AbstractEntity.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/brooklyn/core/entity/AbstractEntity.java b/core/src/main/java/org/apache/brooklyn/core/entity/AbstractEntity.java
index b1b1d27..d91b28f 100644
--- a/core/src/main/java/org/apache/brooklyn/core/entity/AbstractEntity.java
+++ b/core/src/main/java/org/apache/brooklyn/core/entity/AbstractEntity.java
@@ -987,7 +987,7 @@ public abstract class AbstractEntity extends AbstractBrooklynObject implements E
/**
* Direct use of this class is strongly discouraged. It will become private in a future release,
- * once {@link #sensors()} is reverted to return {@link SensorsSupport} instead of
+ * once {@link #sensors()} is reverted to return {@link SensorSupport} instead of
* {@link BasicSensorSupport}.
*/
@Beta
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/f0e0ba7e/core/src/main/java/org/apache/brooklyn/util/core/ResourceUtils.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/brooklyn/util/core/ResourceUtils.java b/core/src/main/java/org/apache/brooklyn/util/core/ResourceUtils.java
index 872332b..26c143d 100644
--- a/core/src/main/java/org/apache/brooklyn/util/core/ResourceUtils.java
+++ b/core/src/main/java/org/apache/brooklyn/util/core/ResourceUtils.java
@@ -478,26 +478,37 @@ public class ResourceUtils {
}
}
- /** allows failing-fast if URL cannot be read */
+ /** @see #checkUrlExists(String, String) */
public String checkUrlExists(String url) {
return checkUrlExists(url, null);
}
-
+
+ /**
+ * Throws if the given URL cannot be read.
+ * @param url The URL to test
+ * @param message An optional message to use for the exception thrown.
+ * @return The URL argument
+ * @see #getResourceFromUrl(String)
+ */
public String checkUrlExists(String url, String message) {
if (url==null) throw new NullPointerException("URL "+(message!=null ? message+" " : "")+"must not be null");
- InputStream s;
+ InputStream s = null;
try {
s = getResourceFromUrl(url);
} catch (Exception e) {
Exceptions.propagateIfFatal(e);
throw new IllegalArgumentException("Unable to access URL "+(message!=null ? message : "")+": "+url, e);
+ } finally {
+ Streams.closeQuietly(s);
}
- Streams.closeQuietly(s);
return url;
}
- /** tests whether the url exists, returning true or false */
- public boolean doesUrlExist(String url) {
+ /**
+ * @return True if the given URL can be read, false otherwise.
+ * @see #getResourceFromUrl(String)
+ */
+ public boolean doesUrlExist(String url) {
InputStream s = null;
try {
s = getResourceFromUrl(url);
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/f0e0ba7e/utils/common/src/main/java/org/apache/brooklyn/config/ConfigKey.java
----------------------------------------------------------------------
diff --git a/utils/common/src/main/java/org/apache/brooklyn/config/ConfigKey.java b/utils/common/src/main/java/org/apache/brooklyn/config/ConfigKey.java
index f2f31fe..3487bc4 100644
--- a/utils/common/src/main/java/org/apache/brooklyn/config/ConfigKey.java
+++ b/utils/common/src/main/java/org/apache/brooklyn/config/ConfigKey.java
@@ -55,8 +55,8 @@ public interface ConfigKey<T> {
* <p>
* This returns a "super" of T only in the case where T is generified,
* and in such cases it returns the Class instance for the unadorned T ---
- * i.e. for List<String> this returns Class<List> ---
- * this is of course because there is no actual Class<List<String>> instance.
+ * i.e. for List<String> this returns Class<List> ---
+ * this is of course because there is no actual Class<List<String>> instance.
*/
Class<? super T> getType();