From b940326231702e8a07dc7e2d3fb5da440bf171cf Mon Sep 17 00:00:00 2001 From: gjoranv Date: Thu, 20 Sep 2018 14:34:05 +0200 Subject: Remove deprecated and unused BindingMatch ctor. --- .../main/java/com/yahoo/jdisc/application/BindingMatch.java | 13 ------------- 1 file changed, 13 deletions(-) (limited to 'jdisc_core/src/main/java/com/yahoo/jdisc/application') 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..9f347706dd8 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 @@ -17,19 +17,6 @@ public class BindingMatch { private final T target; private final UriPattern matched; - /** - *

Constructs a new instance of this class.

- * - * @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); - } - /** *

Constructs a new instance of this class.

* -- cgit v1.2.3 From 80c3df3dfae2d04fe82daa16fcd62ddcfcdd39d3 Mon Sep 17 00:00:00 2001 From: Bjørn Christian Seime Date: Fri, 21 Sep 2018 14:48:39 +0200 Subject: Remove com.yahoo.jdisc.application and com.yahoo.jdisc.client as public api --- jdisc_core/src/main/java/com/yahoo/jdisc/application/package-info.java | 1 - jdisc_core/src/main/java/com/yahoo/jdisc/client/package-info.java | 1 - jdisc_core/src/main/java/com/yahoo/jdisc/package-info.java | 1 - 3 files changed, 3 deletions(-) (limited to 'jdisc_core/src/main/java/com/yahoo/jdisc/application') 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; diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/client/package-info.java b/jdisc_core/src/main/java/com/yahoo/jdisc/client/package-info.java index e0a17245c1f..c328cc1e382 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/client/package-info.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/client/package-info.java @@ -5,5 +5,4 @@ * * @see com.yahoo.jdisc.client.ClientApplication */ -@com.yahoo.api.annotations.PublicApi package com.yahoo.jdisc.client; diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/package-info.java b/jdisc_core/src/main/java/com/yahoo/jdisc/package-info.java index ff8dd242587..d1d842fa3f6 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/package-info.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/package-info.java @@ -50,6 +50,5 @@ * @see com.yahoo.jdisc.service * @see com.yahoo.jdisc.test */ -// TODO: Vespa 7 remove internal classes (at least Container) out of this PublicApi package. @com.yahoo.api.annotations.PublicApi package com.yahoo.jdisc; -- cgit v1.2.3 From 81182050f567673fc3180764b3645fb76ca85dc5 Mon Sep 17 00:00:00 2001 From: gjoranv Date: Tue, 20 Nov 2018 14:46:37 +0100 Subject: Generate html5 javadoc --- .../application/container/handler/Headers.java | 6 ++-- .../processing/IndexingOutputs.java | 2 +- .../java/com/yahoo/vespa/model/package-info.java | 4 +-- .../container/jdisc/MetricConsumerFactory.java | 2 +- .../jdisc/metric/ForwardingMetricConsumer.java | 4 +-- .../jdisc/metric/MetricConsumerProvider.java | 8 ++--- .../container/jdisc/metric/MetricProvider.java | 4 +-- .../search/grouping/result/BucketGroupId.java | 4 +-- .../yahoo/search/grouping/result/ValueGroupId.java | 2 +- .../yahoo/search/query/parser/ParserFactory.java | 2 +- .../main/java/com/yahoo/jdisc/HeaderFields.java | 8 ++--- .../com/yahoo/jdisc/application/BindingMatch.java | 2 +- .../yahoo/jdisc/application/MetricConsumer.java | 10 +++--- .../com/yahoo/jdisc/application/OsgiFramework.java | 14 ++++---- .../com/yahoo/jdisc/application/ResourcePool.java | 8 ++--- .../com/yahoo/jdisc/application/UriPattern.java | 4 +-- .../jdisc/handler/CallableRequestDispatch.java | 4 +-- .../jdisc/handler/CallableResponseDispatch.java | 2 +- .../com/yahoo/jdisc/handler/FutureConjunction.java | 2 +- .../com/yahoo/jdisc/handler/RequestDispatch.java | 4 +-- .../com/yahoo/jdisc/handler/ResponseDispatch.java | 2 +- .../jdisc/handler/ThreadedRequestHandler.java | 2 +- .../jdisc/test/ServerProviderConformanceTest.java | 6 ++-- .../src/main/java/com/yahoo/language/Language.java | 14 ++++---- .../main/java/com/yahoo/messagebus/Routable.java | 2 +- .../com/yahoo/messagebus/routing/RoutingNode.java | 2 +- parent/pom.xml | 22 ------------ .../com/yahoo/searchlib/aggregation/Grouping.java | 6 ++-- .../yahoo/yolean/concurrent/ThreadRobustList.java | 26 +++++++------- .../java/com/yahoo/yolean/trace/TraceNode.java | 40 +++++++++++----------- .../java/com/yahoo/yolean/trace/TraceVisitor.java | 10 +++--- 31 files changed, 103 insertions(+), 125 deletions(-) (limited to 'jdisc_core/src/main/java/com/yahoo/jdisc/application') diff --git a/application/src/main/java/com/yahoo/application/container/handler/Headers.java b/application/src/main/java/com/yahoo/application/container/handler/Headers.java index 8086960df25..ed3018eb430 100644 --- a/application/src/main/java/com/yahoo/application/container/handler/Headers.java +++ b/application/src/main/java/com/yahoo/application/container/handler/Headers.java @@ -155,7 +155,7 @@ public class Headers implements Map> { /** *

Adds all the entries of the given map to this. This is the same as calling {@link #add(String, List)} for each - * entry in values.

+ * entry in values.

* * @param values The values to be added to this. */ @@ -169,8 +169,8 @@ public class Headers implements Map> { * * @param key The key of the entry to put. * @param value The value to put. - * @return The previous value associated with key, or null if there was no mapping for - * key. + * @return The previous value associated with key, or null if there was no mapping for + * key. */ public List put(String key, String value) { return h.put(key, value); diff --git a/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java b/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java index 4feb5b6103b..8c60de1241e 100644 --- a/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java +++ b/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java @@ -17,7 +17,7 @@ import java.util.*; /** * This processor modifies all indexing scripts so that they output to the owning field by default. It also prevents - * any output expression from writing to any field except for the owning field. Finally, for SummaryExpression, + * any output expression from writing to any field except for the owning field. Finally, for SummaryExpression, * this processor expands to write all appropriate summary fields. * * @author Simon Thoresen Hult diff --git a/config-model/src/main/java/com/yahoo/vespa/model/package-info.java b/config-model/src/main/java/com/yahoo/vespa/model/package-info.java index e5f76dd398e..f88eda4e7a2 100644 --- a/config-model/src/main/java/com/yahoo/vespa/model/package-info.java +++ b/config-model/src/main/java/com/yahoo/vespa/model/package-info.java @@ -99,7 +99,7 @@ com.yahoo.config.model.producer.AbstractConfigProducer

-

Plugin Loading

+

Plugin Loading

Each highest-level node in the setup file from the user's application specification corresponds to a {@link @@ -138,7 +138,7 @@ com.yahoo.config.model.producer.AbstractConfigProducer -

Port Allocation

+

Port Allocation

Each {@link com.yahoo.vespa.model.Host Host} has an available dynamic port range running from {@link diff --git a/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java b/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java index 50052bbf70c..d0cf07584e4 100644 --- a/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java +++ b/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java @@ -4,7 +4,7 @@ package com.yahoo.container.jdisc; import com.yahoo.jdisc.application.MetricConsumer; /** - *

This is the interface to implement if one wishes to configure a non-default MetricConsumer. Simply + *

This is the interface to implement if one wishes to configure a non-default MetricConsumer. Simply * add the implementing class as a component in your services.xml file.

* * @author Simon Thoresen Hult diff --git a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java index 7bdd2d9cc7b..c9caaa9d4b5 100644 --- a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java +++ b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java @@ -8,8 +8,8 @@ import com.yahoo.jdisc.application.MetricConsumer; import java.util.Map; /** - *

If more than one {@link MetricConsumerFactory} is registered in a container, calls to Metric need to be - * forwarded to all the underlying MetricConsumers. That is the responsibility of this class. Instances of this + *

If more than one {@link MetricConsumerFactory} is registered in a container, calls to Metric need to be + * forwarded to all the underlying MetricConsumers. That is the responsibility of this class. Instances of this * class is created by the {@link MetricConsumerProvider} in those cases.

* * @author Simon Thoresen Hult diff --git a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java index 1e7a4e75385..a300364d848 100644 --- a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java +++ b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java @@ -11,14 +11,14 @@ import com.yahoo.metrics.MetricsPresentationConfig; /** - *

The purpose of this class it to be the only provider for the MetricConsumer interface in a component + *

The purpose of this class it to be the only provider for the MetricConsumer interface in a component * graph. This component is automatically registered in the graph by the config server. Configuring a different - * MetricConsumer is done by registering one or more {@link MetricConsumerFactory} in the services-file.

+ * MetricConsumer is done by registering one or more {@link MetricConsumerFactory} in the services-file.

* *

Because this class depends on the {@link ComponentRegistry} of {@link MetricConsumerFactory}, any added or removed * {@link MetricConsumerFactory} will cause this component to be reconfigured. Because {@link MetricProvider} depends on - * this class, which means any component that uses Metric will be reconfigured. Any component that depends - * directly on MetricConsumer will also be reconfigured.

+ * this class, which means any component that uses Metric will be reconfigured. Any component that depends + * directly on MetricConsumer will also be reconfigured.

* * @author Simon Thoresen Hult */ diff --git a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java index bcd75c0b36b..57613113e73 100644 --- a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java +++ b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java @@ -6,9 +6,9 @@ import com.yahoo.jdisc.Metric; import com.yahoo.jdisc.application.MetricConsumer; /** - *

This class implements a {@link Provider} component of Metric. Because this class depends on {@link + *

This class implements a {@link Provider} component of Metric. Because this class depends on {@link * MetricConsumerProvider}, any change to the consumer configuration will trigger reconfiguration of this component, - * which in turn triggers reconfiguration of any component that depends on Metric.

+ * which in turn triggers reconfiguration of any component that depends on Metric.

* * @author Simon Thoresen Hult */ diff --git a/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java b/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java index 07729b4524a..e1f74df7172 100644 --- a/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java +++ b/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java @@ -30,9 +30,9 @@ public abstract class BucketGroupId extends GroupId { * * @param type The type of this id's value. * @param from The inclusive-from of the range. - * @param fromImage The String representation of the from argument. + * @param fromImage The String representation of the from argument. * @param to The exclusive-to of the range. - * @param toImage The String representation of the to argument. + * @param toImage The String representation of the to argument. */ public BucketGroupId(String type, T from, String fromImage, T to, String toImage) { super(type, fromImage, toImage); diff --git a/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java b/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java index bebd3fd85b0..a76af885180 100644 --- a/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java +++ b/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java @@ -27,7 +27,7 @@ public abstract class ValueGroupId extends GroupId { * * @param type The type of this id's value. * @param value The identifying value. - * @param valueImage The String representation of the value argument. + * @param valueImage The String representation of the value argument. */ public ValueGroupId(String type, T value, String valueImage) { super(type, valueImage); diff --git a/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java b/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java index 69d46527255..a57c0f98b45 100644 --- a/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java +++ b/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java @@ -18,7 +18,7 @@ public final class ParserFactory { } /** - * Creates a {@link Parser} appropriate for the given Query.Type, providing the Parser with access to + * Creates a {@link Parser} appropriate for the given Query.Type, providing the Parser with access to * the {@link ParserEnvironment} given. * * @param type the query type for which to create a Parser 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 get("foo") returns the same entry as get("FOO"). + * ignoring their case, so that get("foo") returns the same entry as get("FOO"). * * @author Simon Thoresen Hult */ @@ -121,7 +121,7 @@ public class HeaderFields implements Map> { /** *

Adds all the entries of the given map to this. This is the same as calling {@link #add(String, List)} for each - * entry in values.

+ * entry in values.

* * @param values The values to be added to this. */ @@ -137,8 +137,8 @@ public class HeaderFields implements Map> { * * @param key The key of the entry to put. * @param value The value to put. - * @return The previous value associated with key, or null if there was no mapping for - * key. + * @return The previous value associated with key, or null if there was no mapping for + * key. */ public List put(String key, String value) { ArrayList list = new ArrayList(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 { * empty string. This method never returns null.

* * @param idx The index of the group to return. - * @return The (possibly empty) substring captured by the group during matching, never null. + * @return The (possibly empty) substring captured by the group during matching, never null. * @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 { /** - *

Consume a call to Metric.set(String, Number, Metric.Context).

+ *

Consume a call to Metric.set(String, Number, Metric.Context).

* * @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); /** - *

Consume a call to Metric.add(String, Number, Metric.Context).

+ *

Consume a call to Metric.add(String, Number, Metric.Context).

* * @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); /** - *

Creates a Metric.Context object that encapsulates the given properties. The returned Context object - * will be passed along every future call to set(String, Number, Metric.Context) and - * add(String, Number, Metric.Context) where the properties match those given here.

+ *

Creates a Metric.Context object that encapsulates the given properties. The returned Context object + * will be passed along every future call to set(String, Number, Metric.Context) and + * add(String, Number, Metric.Context) where the properties match those given here.

* * @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 { /** *

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 Bundle + * of the bundle. If a bundle containing the same location identifier is already installed, the Bundle * 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 bundleLocation + * header are also installed. The bundle at index 0 of the returned list matches the bundleLocation * argument.

* *

NOTE: When this method installs more than one bundle, AND one of those bundles throw an @@ -29,8 +29,8 @@ public interface OsgiFramework { * BundleInstallationException} that contains the list of successfully installed bundles.

* *

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 Application may choose to - * install bundles concurrently through any available BundleContext.

+ * case of an exception), but that can not be implemented thread-safely since an Application may choose to + * install bundles concurrently through any available BundleContext.

* * @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 installBundle(String bundleLocation) throws BundleException; /** - *

Starts the given {@link Bundle}s. The parameter privileged tells the framework whether or not + *

Starts the given {@link Bundle}s. The parameter privileged 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.

* @@ -63,10 +63,10 @@ public interface OsgiFramework { /** *

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 null if it has no valid + * caller to act on behalf of this bundle. This method may return null if it has no valid * BundleContext.

* - * @return A BundleContext for the system bundle, or null. + * @return A BundleContext for the system bundle, or null. * @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()}).

* * @param t The SharedResource to add. - * @param The class of parameter t. - * @return The parameter t, to allow inlined calls to this function. + * @param The class of parameter t. + * @return The parameter t, to allow inlined calls to this function. */ public T add(T t) { try { @@ -147,8 +147,8 @@ public final class ResourcePool extends AbstractResource implements AutoCloseabl * {@link SharedResource#refer()} call.

* * @param t The SharedResource to retain and add. - * @param The class of parameter t. - * @return The parameter t, to allow inlined calls to this function. + * @param The class of parameter t. + * @return The parameter t, to allow inlined calls to this function. */ public 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 { private final int priority; /** - *

Creates a new instance of this class that represents the given pattern string, with a priority of 0. + *

Creates a new instance of this class that represents the given pattern string, with a priority of 0. * The input string must be on the form <scheme>://<host>[:<port>]<path>, where * '*' can be used as a wildcard character at any position.

* @@ -207,7 +207,7 @@ public class UriPattern implements Comparable { * the empty string. This method never returns null.

* * @param idx The index of the group to return. - * @return The (possibly empty) substring captured by the group during matching, never null. + * @return The (possibly empty) substring captured by the group during matching, never null. * @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 Future return value of - * ExecutorService.submit(Callable) to wait for it. + * does not return until a {@link Response} becomes available, you can use the Future return value of + * ExecutorService.submit(Callable) 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 - * Future return value of ExecutorService.submit(Callable) to wait for it to complete. + * Future return value of ExecutorService.submit(Callable) 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.*; /** *

This class implements a Future<Boolean> that is conjunction of zero or more other Future<Boolean>s, - * i.e. it evaluates to true if, and only if, all its operands evaluate to true. To use this class, + * i.e. it evaluates to true if, and only if, all its operands evaluate to true. To use this class, * simply create an instance of it and add operands to it using the {@link #addOperand(ListenableFuture)} method.

* 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, Res /** *

This methods calls {@link #newRequest()} to create a new {@link Request}, and then calls {@link - * Request#connect(ResponseHandler)} on that. This method uses a finally block to make sure that the + * Request#connect(ResponseHandler)} on that. This method uses a finally block to make sure that the * Request is always {@link Request#release() released}.

* * @return The ContentChannel to write the Request's content to. @@ -98,7 +98,7 @@ public abstract class RequestDispatch implements ListenableFuture, Res /** *

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 finally block to make sure that the ContentChannel is always {@link + * ContentChannel. This method uses a finally block to make sure that the ContentChannel is always {@link * ContentChannel#close(CompletionHandler) closed}.

* *

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 ForwardingListenableFutureThis 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 finally block to make sure that the ContentChannel is always + * to that ContentChannel. This method uses a finally block to make sure that the ContentChannel is always * {@link ContentChannel#close(CompletionHandler) closed}.

*

The returned Future will wait for all CompletionHandlers associated with the Response have been * completed.

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 { /** *

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 - * Response.Status.NOT_IMPLEMENTED status.

+ * Response.Status.NOT_IMPLEMENTED status.

* * @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; /** - *

This interface declares the adapter between the general conformance test and an actual ServerProvider + *

This interface declares the adapter between the general conformance test and an actual ServerProvider * implementation. Every test runs as follows:

*
    *
  1. {@link #newConfigModule()} is called to bind server-specific configuration.
    2. @@ -59,7 +59,7 @@ public abstract class ServerProviderConformanceTest { *
  2. {@link #validateResponse(Object)} is called once per call to {@link #executeRequest(Object, boolean)}.
    3. *
* - * @param The ServerProvider under test. + * @param The ServerProvider under test. * @param An object that represents a remote client that can connect to the server. * @param An object that holds the response generated by the client when executing a request. */ @@ -80,7 +80,7 @@ public abstract class ServerProviderConformanceTest { /** *

An instance of this exception is thrown within the conformance tests that imply that they will throw an - * exception. If your ServerProvider is capable of exposing such information, then this class is what you + * exception. If your ServerProvider is capable of exposing such information, then this class is what you * need to look for in the output.

*/ public static class ConformanceException extends RuntimeException { diff --git a/linguistics/src/main/java/com/yahoo/language/Language.java b/linguistics/src/main/java/com/yahoo/language/Language.java index ab8bcd4459f..655a9003fb1 100644 --- a/linguistics/src/main/java/com/yahoo/language/Language.java +++ b/linguistics/src/main/java/com/yahoo/language/Language.java @@ -529,10 +529,10 @@ public enum Language { } /** - *

Convenience method for calling fromLocale(LocaleFactory.fromLanguageTag(languageTag)).

+ *

Convenience method for calling fromLocale(LocaleFactory.fromLanguageTag(languageTag)).

* - * @param languageTag The language tag for which the Language to return. - * @return the corresponding Language, or {@link #UNKNOWN} if not known. + * @param languageTag The language tag for which the Language to return. + * @return the corresponding Language, or {@link #UNKNOWN} if not known. */ public static Language fromLanguageTag(String languageTag) { if (languageTag == null) return UNKNOWN; @@ -540,7 +540,7 @@ public enum Language { } /** - *

Returns the Language whose {@link #languageCode()} is equal to locale.getLanguage(), with + *

Returns the Language whose {@link #languageCode()} is equal to locale.getLanguage(), with * the following additions:

*
    *
  • Language code "in" translates to {@link #INDONESIAN}
    • @@ -551,8 +551,8 @@ public enum Language { * is "hans", in which case it translates to {@link #CHINESE_SIMPLIFIED}. *
* - * @param locale The locale for which the Language to return. - * @return The corresponding Language, or {@link #UNKNOWN} if not known. + * @param locale The locale for which the Language to return. + * @return The corresponding Language, or {@link #UNKNOWN} if not known. */ public static Language fromLocale(Locale locale) { String str = locale.getLanguage(); @@ -582,7 +582,7 @@ public enum Language { /** * Returns the language from an encoding, or {@link #UNKNOWN} if it cannot be determined. * - * @param encoding The name of the encoding to derive the Language from. + * @param encoding The name of the encoding to derive the Language from. * @return the language given by the encoding, or {@link #UNKNOWN} if not determined. */ public static Language fromEncoding(String encoding) { diff --git a/messagebus/src/main/java/com/yahoo/messagebus/Routable.java b/messagebus/src/main/java/com/yahoo/messagebus/Routable.java index e761a874ac1..792ec4d27cd 100755 --- a/messagebus/src/main/java/com/yahoo/messagebus/Routable.java +++ b/messagebus/src/main/java/com/yahoo/messagebus/Routable.java @@ -60,7 +60,7 @@ public abstract class Routable { /** *

This is a convenience method for calling {@link CallStack#pop(Routable)} on the {@link CallStack} of this - * Routable. It equals calling routable.getCallStack().pop(routable).

+ * Routable. It equals calling routable.getCallStack().pop(routable).

* * @return The handler that was popped. * @see CallStack#pop(Routable) diff --git a/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java b/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java index 3049639586d..d2d8031a689 100755 --- a/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java +++ b/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java @@ -258,7 +258,7 @@ public class RoutingNode implements ReplyHandler { } /** - * If a reply has been set containing an error, and {@link #shouldIgnoreResult()} returns true, this method + * If a reply has been set containing an error, and {@link #shouldIgnoreResult()} returns true, this method * replaces that reply with one that has no error. * * @return Whether or not the reply was replaced. diff --git a/parent/pom.xml b/parent/pom.xml index 398d136c155..2e22c36cee3 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -279,28 +279,6 @@ - - - jdk10 - - [10, ) - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - - true - - -html4 - - - - - - attach-sources diff --git a/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java b/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java index a9e2bc73d6a..c13bde4b633 100644 --- a/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java +++ b/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java @@ -209,7 +209,7 @@ public class Grouping extends Identifiable { * * @param level The level to add. * @return This, to allow chaining. - * @throws NullPointerException If level argument is null. + * @throws NullPointerException If level argument is null. */ public Grouping addLevel(GroupingLevel level) { level.getClass(); // throws NullPointerException @@ -231,7 +231,7 @@ public class Grouping extends Identifiable { * * @param root The group to set as root. * @return This, to allow chaining. - * @throws NullPointerException If root argument is null. + * @throws NullPointerException If root argument is null. */ public Grouping setRoot(Group root) { root.getClass(); // throws NullPointerException @@ -249,7 +249,7 @@ public class Grouping extends Identifiable { } /** - *

Sets whether or not grouping should be forced to execute in a single pass. If false, this Grouping + *

Sets whether or not grouping should be forced to execute in a single pass. If false, this Grouping * might still execute in a single pass due to other constraints.

* * @param forceSinglePass True to force execution in single pass. diff --git a/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java b/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java index 3f57319cdce..72020bbaf88 100644 --- a/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java +++ b/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java @@ -8,15 +8,15 @@ import java.util.NoSuchElementException; /** *

This class implements a thread-safe, lock-free list of Objects that supports multiple readers and a single writer. * Because there are no locks or other memory barriers involved, there exists no happens-before relationship - * among calls to either methods of the ThreadRobustList. This means that there are no guarantees as to when + * among calls to either methods of the ThreadRobustList. This means that there are no guarantees as to when * (or even if) an item {@link #add(Object)}ed becomes visible through {@link #iterator()}. If visibility is required, * either use explicit synchronization between reader and writer thread, or move to a different concurrent collection - * (e.g. CopyOnWriteArrayList).

- *

Because it is lock-free, the ThreadRobustList has minimal overhead to both reading and writing. The + * (e.g. CopyOnWriteArrayList).

+ *

Because it is lock-free, the ThreadRobustList has minimal overhead to both reading and writing. The * iterator offered by this class always observes the list in a consistent state, and it never throws a - * ConcurrentModificationException.

- *

The ThreadRobustList does not permit adding null items.

- *

The usage of ThreadRobustList has no memory consistency effects.

+ * ConcurrentModificationException.

+ *

The ThreadRobustList does not permit adding null items.

+ *

The usage of ThreadRobustList has no memory consistency effects.

* * @author Steinar Knutsen * @author bratseth @@ -28,7 +28,7 @@ public class ThreadRobustList implements Iterable { private int next = 0; /** - *

Constructs a new instance of this class with an initial capacity of 10.

+ *

Constructs a new instance of this class with an initial capacity of 10.

*/ public ThreadRobustList() { this(10); @@ -46,18 +46,18 @@ public class ThreadRobustList implements Iterable { /** *

Returns whether or not this list is empty.

* - * @return true if this list has zero items + * @return true if this list has zero items */ public boolean isEmpty() { return next == 0; } /** - *

Adds an item to this list. As opposed to CopyOnWriteArrayList, items added to this list may become + *

Adds an item to this list. As opposed to CopyOnWriteArrayList, items added to this list may become * visible to iterators created before a call to this method.

* * @param item the item to add - * @throws NullPointerException if item is null + * @throws NullPointerException if item is null */ public void add(T item) { if (item == null) { @@ -74,9 +74,9 @@ public class ThreadRobustList implements Iterable { } /** - *

Returns an iterator over the items in this list. As opposed to CopyOnWriteArrayList, this iterator - * may see items added to the ThreadRobustList even if they occur after a call to this method.

- *

The returned iterator does not support remove().

+ *

Returns an iterator over the items in this list. As opposed to CopyOnWriteArrayList, this iterator + * may see items added to the ThreadRobustList even if they occur after a call to this method.

+ *

The returned iterator does not support remove().

* * @return an iterator over this list */ diff --git a/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java b/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java index 92e083c9998..b3c4d67db47 100644 --- a/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java +++ b/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java @@ -10,16 +10,16 @@ import java.util.List; import java.util.NoSuchElementException; /** - *

This class represents a single node in a tree of TraceNodes. The trace forms a tree where there is a - * branch for each parallel execution, and a node within such a branch for each traced event. As each TraceNode + *

This class represents a single node in a tree of TraceNodes. The trace forms a tree where there is a + * branch for each parallel execution, and a node within such a branch for each traced event. As each TraceNode * may contain a payload of any type, the trace tree can be used to exchange any thread-safe state between producers and * consumers in different threads, whether or not the shape of the trace tree is relevant to the particular * information.

*

This class uses a {@link ThreadRobustList} for its children. That list allows multiple threads to inspect the - * hierarchy of a TraceNode tree while there are other threads concurrently modifying it, without incurring the - * cost of memory synchronization. The only caveat being that for each TraceNode there can never be more than - * exactly one writer thread. If multiple threads need to mutate a single TraceNode, then the writer threads - * need to synchronize their access on the TraceNode.

+ * hierarchy of a TraceNode tree while there are other threads concurrently modifying it, without incurring the + * cost of memory synchronization. The only caveat being that for each TraceNode there can never be more than + * exactly one writer thread. If multiple threads need to mutate a single TraceNode, then the writer threads + * need to synchronize their access on the TraceNode.

* * @author Steinar Knutsen * @author bratseth @@ -35,7 +35,7 @@ public class TraceNode { /** *

Creates a new instance of this class.

* - * @param payload the payload to assign to this, may be null + * @param payload the payload to assign to this, may be null * @param timestamp the timestamp to assign to this */ public TraceNode(Object payload, long timestamp) { @@ -44,11 +44,11 @@ public class TraceNode { } /** - *

Adds another TraceNode as a child to this.

+ *

Adds another TraceNode as a child to this.

* * @param child the TraceNode to add * @return this, to allow chaining - * @throws IllegalArgumentException if child is not a root TraceNode + * @throws IllegalArgumentException if child is not a root TraceNode * @see #isRoot() */ public TraceNode add(TraceNode child) { @@ -64,12 +64,12 @@ public class TraceNode { } /** - *

Returns a read-only iterable of all {@link #payload() payloads} that are instances of payloadType, - * in all its decendants. The payload of this TraceNode is ignored.

+ *

Returns a read-only iterable of all {@link #payload() payloads} that are instances of payloadType, + * in all its decendants. The payload of this TraceNode is ignored.

*

The payloads are retrieved in depth-first, prefix order.

* * @param payloadType the type of payloads to retrieve - * @return the payloads, never null + * @return the payloads, never null */ public Iterable descendants(final Class payloadType) { if (children == null) { @@ -85,7 +85,7 @@ public class TraceNode { } /** - *

Returns the payload of this TraceNode, or null if none.

+ *

Returns the payload of this TraceNode, or null if none.

* * @return the payload */ @@ -94,7 +94,7 @@ public class TraceNode { } /** - *

Returns the timestamp of this TraceNode.

+ *

Returns the timestamp of this TraceNode.

* * @return the timestamp */ @@ -103,7 +103,7 @@ public class TraceNode { } /** - *

Returns the parent TraceNode of this.

+ *

Returns the parent TraceNode of this.

* * @return the parent */ @@ -112,7 +112,7 @@ public class TraceNode { } /** - *

Returns the child TraceNodes of this.

+ *

Returns the child TraceNodes of this.

* * @return the children */ @@ -124,16 +124,16 @@ public class TraceNode { } /** - *

Returns whether or not this TraceNode is a root node (i.e. it has no parent).

+ *

Returns whether or not this TraceNode is a root node (i.e. it has no parent).

* - * @return true if {@link #parent()} returns null + * @return true if {@link #parent()} returns null */ public boolean isRoot() { return parent == null; } /** - *

Returns the root TraceNode of the tree that this TraceNode belongs to.

+ *

Returns the root TraceNode of the tree that this TraceNode belongs to.

* * @return the root */ @@ -146,7 +146,7 @@ public class TraceNode { } /** - *

Visits this TraceNode and all of its descendants in depth-first, prefix order.

+ *

Visits this TraceNode and all of its descendants in depth-first, prefix order.

* * @param visitor The visitor to accept. * @return The visitor parameter. diff --git a/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java b/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java index c45823da19a..23525b65571 100644 --- a/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java +++ b/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java @@ -13,17 +13,17 @@ public abstract class TraceVisitor { *

Visits a {@link TraceNode}. Called by {@link TraceNode#accept(TraceVisitor)}, before visiting its * children.

* - * @param node the TraceNode being visited + * @param node the TraceNode being visited * @see TraceNode#accept(TraceVisitor) */ public abstract void visit(TraceNode node); /** *

Enters a {@link TraceNode}. This method is called after {@link #visit(TraceNode)}, but before visiting its - * children. Note that this method is NOT called if a TraceNode has zero children.

+ * children. Note that this method is NOT called if a TraceNode has zero children.

*

The default implementation of this method does nothing.

* - * @param node the TraceNode being entered + * @param node the TraceNode being entered * @see #leaving(TraceNode) */ @SuppressWarnings("UnusedParameters") @@ -33,10 +33,10 @@ public abstract class TraceVisitor { /** *

Leaves a {@link TraceNode}. This method is called after {@link #entering(TraceNode)}, and after visiting its - * children. Note that this method is NOT called if a TraceNode has zero children.

+ * children. Note that this method is NOT called if a TraceNode has zero children.

*

The default implementation of this method does nothing.

* - * @param node the TraceNode being left + * @param node the TraceNode being left */ @SuppressWarnings("UnusedParameters") public void leaving(TraceNode node) { -- cgit v1.2.3