aboutsummaryrefslogtreecommitdiffstats
path: root/jdisc_core/src/main/java/com/yahoo/jdisc/application
diff options
context:
space:
mode:
authorGeir Storli <geirstorli@yahoo.no>2019-01-21 16:06:53 +0100
committerGitHub <noreply@github.com>2019-01-21 16:06:53 +0100
commit8372a883c5a5fa100f88fc9b80824359b5bb70cd (patch)
tree660ce3ef61f060b33bd97eac1185715606b8e2bd /jdisc_core/src/main/java/com/yahoo/jdisc/application
parent3722c1cdd91fce30d1c2538b2a8749d9321e194b (diff)
parenteb0b1134a66507e3bd8f09793c22cd824d01dff5 (diff)
Merge pull request #8198 from vespa-engine/7
7 MERGEOK
Diffstat (limited to 'jdisc_core/src/main/java/com/yahoo/jdisc/application')
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java15
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java10
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java14
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java8
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java4
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/application/package-info.java1
6 files changed, 19 insertions, 33 deletions
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java
index 7318b1b38ae..98b0ef870e1 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java
@@ -22,19 +22,6 @@ public class BindingMatch<T> {
*
* @param match The match information for this instance.
* @param target The target of this match.
- * @throws NullPointerException If any argument is null.
- * @deprecated use BindingMatch(UriPattern.Match match, T target, UriPattern matched)
- */
- @Deprecated
- public BindingMatch(UriPattern.Match match, T target) {
- this(match, target, null);
- }
-
- /**
- * <p>Constructs a new instance of this class.</p>
- *
- * @param match The match information for this instance.
- * @param target The target of this match.
* @param matched The matched URI pattern
* @throws NullPointerException If any argument is null.
*/
@@ -62,7 +49,7 @@ public class BindingMatch<T> {
* empty string. This method never returns null.</p>
*
* @param idx The index of the group to return.
- * @return The (possibly empty) substring captured by the group during matching, never <tt>null</tt>.
+ * @return The (possibly empty) substring captured by the group during matching, never <code>null</code>.
* @throws IndexOutOfBoundsException If there is no group in the match with the given index.
*/
public String group(int idx) {
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java
index d9bf67b530f..f060f1840ff 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java
@@ -39,7 +39,7 @@ import java.util.Map;
public interface MetricConsumer {
/**
- * <p>Consume a call to <tt>Metric.set(String, Number, Metric.Context)</tt>.</p>
+ * <p>Consume a call to <code>Metric.set(String, Number, Metric.Context)</code>.</p>
*
* @param key The name of the metric to modify.
* @param val The value to assign to the named metric.
@@ -48,7 +48,7 @@ public interface MetricConsumer {
public void set(String key, Number val, Metric.Context ctx);
/**
- * <p>Consume a call to <tt>Metric.add(String, Number, Metric.Context)</tt>.</p>
+ * <p>Consume a call to <code>Metric.add(String, Number, Metric.Context)</code>.</p>
*
* @param key The name of the metric to modify.
* @param val The value to add to the named metric.
@@ -57,9 +57,9 @@ public interface MetricConsumer {
public void add(String key, Number val, Metric.Context ctx);
/**
- * <p>Creates a <tt>Metric.Context</tt> object that encapsulates the given properties. The returned Context object
- * will be passed along every future call to <tt>set(String, Number, Metric.Context)</tt> and
- * <tt>add(String, Number, Metric.Context)</tt> where the properties match those given here.</p>
+ * <p>Creates a <code>Metric.Context</code> object that encapsulates the given properties. The returned Context object
+ * will be passed along every future call to <code>set(String, Number, Metric.Context)</code> and
+ * <code>add(String, Number, Metric.Context)</code> where the properties match those given here.</p>
*
* @param properties The properties to incorporate in the context.
* @return The created context.
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java
index 85d745d7aaf..5abc95cc610 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java
@@ -18,9 +18,9 @@ public interface OsgiFramework {
/**
* <p>Installs a bundle from the specified location. The specified location identifier will be used as the identity
- * of the bundle. If a bundle containing the same location identifier is already installed, the <tt>Bundle</tt>
+ * of the bundle. If a bundle containing the same location identifier is already installed, the <code>Bundle</code>
* object for that bundle is returned. All bundles listed in the {@link OsgiHeader#PREINSTALL_BUNDLE} manifest
- * header are also installed. The bundle at index 0 of the returned list matches the <tt>bundleLocation</tt>
+ * header are also installed. The bundle at index 0 of the returned list matches the <code>bundleLocation</code>
* argument.</p>
*
* <p><b>NOTE:</b> When this method installs more than one bundle, <em>AND</em> one of those bundles throw an
@@ -29,8 +29,8 @@ public interface OsgiFramework {
* BundleInstallationException} that contains the list of successfully installed bundles.</p>
*
* <p>It would be preferable if this method was exception-safe (that it would roll-back all installed bundles in the
- * case of an exception), but that can not be implemented thread-safely since an <tt>Application</tt> may choose to
- * install bundles concurrently through any available <tt>BundleContext</tt>.</p>
+ * case of an exception), but that can not be implemented thread-safely since an <code>Application</code> may choose to
+ * install bundles concurrently through any available <code>BundleContext</code>.</p>
*
* @param bundleLocation The location identifier of the bundle to install.
* @return The list of Bundle objects installed, the object at index 0 matches the given location.
@@ -41,7 +41,7 @@ public interface OsgiFramework {
List<Bundle> installBundle(String bundleLocation) throws BundleException;
/**
- * <p>Starts the given {@link Bundle}s. The parameter <tt>privileged</tt> tells the framework whether or not
+ * <p>Starts the given {@link Bundle}s. The parameter <code>privileged</code> tells the framework whether or not
* privileges are available, and is checked against the {@link OsgiHeader#PRIVILEGED_ACTIVATOR} header of each
* Bundle being started. Any bundle that is a fragment is silently ignored.</p>
*
@@ -63,10 +63,10 @@ public interface OsgiFramework {
/**
* <p>Returns the BundleContext of this framework's system bundle. The returned BundleContext can be used by the
- * caller to act on behalf of this bundle. This method may return <tt>null</tt> if it has no valid
+ * caller to act on behalf of this bundle. This method may return <code>null</code> if it has no valid
* BundleContext.</p>
*
- * @return A <tt>BundleContext</tt> for the system bundle, or <tt>null</tt>.
+ * @return A <code>BundleContext</code> for the system bundle, or <code>null</code>.
* @throws SecurityException If the caller does not have the appropriate permissions.
*/
BundleContext bundleContext();
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java
index 279d99f63b7..ccbd1693b21 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java
@@ -87,8 +87,8 @@ public final class ResourcePool extends AbstractResource implements AutoCloseabl
* destroyed, it will release the main reference to the resource (by calling {@link SharedResource#release()}).</p>
*
* @param t The SharedResource to add.
- * @param <T> The class of parameter <tt>t</tt>.
- * @return The parameter <tt>t</tt>, to allow inlined calls to this function.
+ * @param <T> The class of parameter <code>t</code>.
+ * @return The parameter <code>t</code>, to allow inlined calls to this function.
*/
public <T extends SharedResource> T add(T t) {
try {
@@ -147,8 +147,8 @@ public final class ResourcePool extends AbstractResource implements AutoCloseabl
* {@link SharedResource#refer()} call.</p>
*
* @param t The SharedResource to retain and add.
- * @param <T> The class of parameter <tt>t</tt>.
- * @return The parameter <tt>t</tt>, to allow inlined calls to this function.
+ * @param <T> The class of parameter <code>t</code>.
+ * @return The parameter <code>t</code>, to allow inlined calls to this function.
*/
public <T extends SharedResource> T retain(T t) {
resources.add(t.refer());
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java
index 89cb6412181..0e6e5d28260 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java
@@ -40,7 +40,7 @@ public class UriPattern implements Comparable<UriPattern> {
private final int priority;
/**
- * <p>Creates a new instance of this class that represents the given pattern string, with a priority of <tt>0</tt>.
+ * <p>Creates a new instance of this class that represents the given pattern string, with a priority of <code>0</code>.
* The input string must be on the form <code>&lt;scheme&gt;://&lt;host&gt;[:&lt;port&gt;]&lt;path&gt;</code>, where
* '*' can be used as a wildcard character at any position.</p>
*
@@ -207,7 +207,7 @@ public class UriPattern implements Comparable<UriPattern> {
* the empty string. This method never returns null.</p>
*
* @param idx The index of the group to return.
- * @return The (possibly empty) substring captured by the group during matching, never <tt>null</tt>.
+ * @return The (possibly empty) substring captured by the group during matching, never <code>null</code>.
* @throws IndexOutOfBoundsException If there is no group in the match with the given index.
*/
public String group(int idx) {
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/package-info.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/package-info.java
index 9308bc4d17a..c856712e1af 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/package-info.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/package-info.java
@@ -148,5 +148,4 @@ $ sudo jdisc_start target/myapp.jar
* @see com.yahoo.jdisc.handler
* @see com.yahoo.jdisc.service
*/
-@com.yahoo.api.annotations.PublicApi
package com.yahoo.jdisc.application;