Thomas Vachuska
Committed by Gerrit Code Review

Fixed javadoc warnings & added a few deprecations.

Change-Id: I89205b08bc5fcbfed769c489609a46d420ee227e
......@@ -17,6 +17,9 @@ package org.onosproject.config;
/**
* Service interface exported by the Network Configuration.
*
* @deprecated in Drake; see org.onosproject.net.config
*/
@Deprecated
public interface NetworkConfigService {
}
......
......@@ -16,7 +16,10 @@ import org.onosproject.segmentrouting.config.NetworkConfig.SwitchConfig;
*
* TODO: return immutable objects or defensive copies of network config so that
* users of this API do not inadvertently or maliciously change network config.
*
* @deprecated in Drake; see org.onosproject.net.config
*/
@Deprecated
public interface NetworkConfigService {
/**
......
......@@ -236,6 +236,8 @@ public abstract class Tools {
* @param maxDelayBetweenRetries max delay between successive retries. The actual delay is randomly picked from
* the interval (0, maxDelayBetweenRetries]
* @return function
* @param <U> type of function input
* @param <V> type of function output
*/
public static <U, V> Function<U, V> retryable(Function<U, V> base,
Class<? extends Throwable> exceptionClass,
......@@ -252,6 +254,7 @@ public abstract class Tools {
* @param maxDelayBetweenRetries max delay between successive retries. The actual delay is randomly picked from
* the interval (0, maxDelayBetweenRetries]
* @return supplier
* @param <V> type of supplied result
*/
public static <V> Supplier<V> retryable(Supplier<V> base,
Class<? extends Throwable> exceptionClass,
......
......@@ -17,6 +17,10 @@ package org.onlab.util;
/**
* A consumer that accepts three arguments.
*
* @param <U> type of first argument
* @param <V> type of second argument
* @param <W> type of third argument
*/
public interface TriConsumer<U, V, W> {
......
......@@ -107,6 +107,8 @@ public class ApiDocResource extends AbstractInjectionResource {
* Get Swagger UI main index page.
*
* @return 200 OK
* @throws IOException if unable to get index resource
* @throws URISyntaxException if unable to create redirect URI
*/
@GET
@Path("/")
......@@ -119,6 +121,7 @@ public class ApiDocResource extends AbstractInjectionResource {
* Get Swagger UI main index page.
*
* @return 200 OK
* @throws IOException if unable to get index resource
*/
@GET
@Path("index.html")
......@@ -155,7 +158,9 @@ public class ApiDocResource extends AbstractInjectionResource {
/**
* Get Swagger UI resource.
*
* @param resource path of the resource
* @return 200 OK
* @throws IOException if unable to get named resource
*/
@GET
@Path("{resource: .*}")
......
......@@ -77,6 +77,7 @@ public class ClusterWebResource extends AbstractWebResource {
*
* @param config cluster definition
* @return 200 OK
* @throws IOException to signify bad request
*/
@POST
@Path("configuration")
......
......@@ -82,7 +82,9 @@ public class ComponentConfigWebResource extends AbstractWebResource {
* Sets only the properties present in the JSON request.
*
* @param component component name
* @param request JSON configuration
* @return 200 OK
* @throws IOException to signify bad request
*/
@POST
@Path("{component}")
......@@ -100,7 +102,9 @@ public class ComponentConfigWebResource extends AbstractWebResource {
* Clears only the properties present in the JSON request.
*
* @param component component name
* @param request JSON configuration
* @return 200 OK
* @throws IOException to signify bad request
*/
@DELETE
@Path("{component}")
......