aboutsummaryrefslogtreecommitdiffstats
path: root/jdisc_core
diff options
context:
space:
mode:
authorgjoranv <gv@oath.com>2018-11-20 14:46:37 +0100
committergjoranv <gv@oath.com>2019-01-21 15:09:27 +0100
commit81182050f567673fc3180764b3645fb76ca85dc5 (patch)
treecae51ade6b09ccbe7d316efb7b3d5b93e8bd3f18 /jdisc_core
parent0fb27af8c2d6b8e5ebb0255e21c220a89ce05eba (diff)
Generate html5 javadoc
Diffstat (limited to 'jdisc_core')
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java8
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java2
-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/handler/CallableRequestDispatch.java4
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java2
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java2
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java4
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java2
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java2
-rw-r--r--jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java6
13 files changed, 34 insertions, 34 deletions
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java b/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java
index 500b1258735..5c35bed2cec 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java
@@ -8,7 +8,7 @@ import java.util.*;
/**
* This is an encapsulation of the header fields that belong to either a {@link Request} or a {@link Response}. It is
* a multimap from String to String, with some additional methods for convenience. The keys of this map are compared by
- * ignoring their case, so that <tt>get("foo")</tt> returns the same entry as <tt>get("FOO")</tt>.
+ * ignoring their case, so that <code>get("foo")</code> returns the same entry as <code>get("FOO")</code>.
*
* @author Simon Thoresen Hult
*/
@@ -121,7 +121,7 @@ public class HeaderFields implements Map<String, List<String>> {
/**
* <p>Adds all the entries of the given map to this. This is the same as calling {@link #add(String, List)} for each
- * entry in <tt>values</tt>.</p>
+ * entry in <code>values</code>.</p>
*
* @param values The values to be added to this.
*/
@@ -137,8 +137,8 @@ public class HeaderFields implements Map<String, List<String>> {
*
* @param key The key of the entry to put.
* @param value The value to put.
- * @return The previous value associated with <tt>key</tt>, or <tt>null</tt> if there was no mapping for
- * <tt>key</tt>.
+ * @return The previous value associated with <code>key</code>, or <code>null</code> if there was no mapping for
+ * <code>key</code>.
*/
public List<String> put(String key, String value) {
ArrayList<String> list = new ArrayList<String>(1);
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 9f347706dd8..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
@@ -49,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/handler/CallableRequestDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableRequestDispatch.java
index cfbd4edcf8f..135a56f2d6b 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableRequestDispatch.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableRequestDispatch.java
@@ -8,8 +8,8 @@ import java.util.concurrent.Callable;
/**
* This is a convenient subclass of {@link RequestDispatch} that implements the {@link Callable} interface. This
* should be used in place of {@link RequestDispatch} if you intend to schedule its execution. Because {@link #call()}
- * does not return until a {@link Response} becomes available, you can use the <tt>Future</tt> return value of
- * <tt>ExecutorService.submit(Callable)</tt> to wait for it.
+ * does not return until a {@link Response} becomes available, you can use the <code>Future</code> return value of
+ * <code>ExecutorService.submit(Callable)</code> to wait for it.
*
* @author Simon Thoresen Hult
*/
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java
index 0471e05a5f9..e92edf15bba 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java
@@ -9,7 +9,7 @@ import java.util.concurrent.Callable;
* This is a convenient subclass of {@link ResponseDispatch} that implements the {@link Callable} interface. This
* should be used in place of {@link ResponseDispatch} if you intend to schedule its execution. Because {@link #call()}
* does not return until the entirety of the {@link Response} and its content have been consumed, you can use the
- * <tt>Future</tt> return value of <tt>ExecutorService.submit(Callable)</tt> to wait for it to complete.
+ * <code>Future</code> return value of <code>ExecutorService.submit(Callable)</code> to wait for it to complete.
*
* @author Simon Thoresen Hult
*/
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java
index 4380ad0cbd2..c48798ca2ab 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java
@@ -11,7 +11,7 @@ import java.util.concurrent.*;
/**
* <p>This class implements a Future&lt;Boolean&gt; that is conjunction of zero or more other Future&lt;Boolean&gt;s,
- * i.e. it evaluates to <tt>true</tt> if, and only if, all its operands evaluate to <tt>true</tt>. To use this class,
+ * i.e. it evaluates to <code>true</code> if, and only if, all its operands evaluate to <code>true</code>. To use this class,
* simply create an instance of it and add operands to it using the {@link #addOperand(ListenableFuture)} method.</p>
* TODO: consider rewriting usage of FutureConjunction to use CompletableFuture instead.
*
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java
index 211c5474fe6..3dc0961cdcb 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java
@@ -73,7 +73,7 @@ public abstract class RequestDispatch implements ListenableFuture<Response>, Res
/**
* <p>This methods calls {@link #newRequest()} to create a new {@link Request}, and then calls {@link
- * Request#connect(ResponseHandler)} on that. This method uses a <tt>finally</tt> block to make sure that the
+ * Request#connect(ResponseHandler)} on that. This method uses a <code>finally</code> block to make sure that the
* Request is always {@link Request#release() released}.</p>
*
* @return The ContentChannel to write the Request's content to.
@@ -98,7 +98,7 @@ public abstract class RequestDispatch implements ListenableFuture<Response>, Res
/**
* <p>This method calls {@link #connect()} to establish a {@link ContentChannel} for the {@link Request}, and then
* iterates through all the ByteBuffers returned by {@link #requestContent()} and writes them to that
- * ContentChannel. This method uses a <tt>finally</tt> block to make sure that the ContentChannel is always {@link
+ * ContentChannel. This method uses a <code>finally</code> block to make sure that the ContentChannel is always {@link
* ContentChannel#close(CompletionHandler) closed}.</p>
*
* <p>The returned Future will wait for all CompletionHandlers associated with the Request have been completed, and
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java
index e5e6b752716..22a77968dfd 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java
@@ -82,7 +82,7 @@ public abstract class ResponseDispatch extends ForwardingListenableFuture<Boolea
/**
* <p>This method calls {@link #connect(ResponseHandler)} to establish a {@link ContentChannel} for the {@link
* Response}, and then iterates through all the ByteBuffers returned by {@link #responseContent()} and writes them
- * to that ContentChannel. This method uses a <tt>finally</tt> block to make sure that the ContentChannel is always
+ * to that ContentChannel. This method uses a <code>finally</code> block to make sure that the ContentChannel is always
* {@link ContentChannel#close(CompletionHandler) closed}.</p>
* <p>The returned Future will wait for all CompletionHandlers associated with the Response have been
* completed.</p>
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java
index a2bea1566de..6e2895f118b 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java
@@ -126,7 +126,7 @@ public abstract class ThreadedRequestHandler extends AbstractRequestHandler {
/**
* <p>Implement this method if you want to access the {@link Request}'s content using a {@link ContentInputStream}.
* If you do not override this method, it will dispatch a {@link Response} to the {@link ResponseHandler} with a
- * <tt>Response.Status.NOT_IMPLEMENTED</tt> status.</p>
+ * <code>Response.Status.NOT_IMPLEMENTED</code> status.</p>
*
* @param request The Request to handle.
* @param responseHandler The handler to pass the corresponding {@link Response} to.
diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java b/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java
index e7039e85e5e..7e913456074 100644
--- a/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java
+++ b/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java
@@ -49,7 +49,7 @@ public abstract class ServerProviderConformanceTest {
private static final int NUM_RUNS_EACH_TEST = 10;
/**
- * <p>This interface declares the adapter between the general conformance test and an actual <tt>ServerProvider</tt>
+ * <p>This interface declares the adapter between the general conformance test and an actual <code>ServerProvider</code>
* implementation. Every test runs as follows:</p>
* <ol>
* <li>{@link #newConfigModule()} is called to bind server-specific configuration.</li>
@@ -59,7 +59,7 @@ public abstract class ServerProviderConformanceTest {
* <li>{@link #validateResponse(Object)} is called once per call to {@link #executeRequest(Object, boolean)}.</li>
* </ol>
*
- * @param <T> The <tt>ServerProvider</tt> under test.
+ * @param <T> The <code>ServerProvider</code> under test.
* @param <U> An object that represents a remote client that can connect to the server.
* @param <V> An object that holds the response generated by the client when executing a request.
*/
@@ -80,7 +80,7 @@ public abstract class ServerProviderConformanceTest {
/**
* <p>An instance of this exception is thrown within the conformance tests that imply that they will throw an
- * exception. If your <tt>ServerProvider</tt> is capable of exposing such information, then this class is what you
+ * exception. If your <code>ServerProvider</code> is capable of exposing such information, then this class is what you
* need to look for in the output.</p>
*/
public static class ConformanceException extends RuntimeException {