Updated annotations

Removed exceptions not thrown
Updated params in javadocs
Fixed broken doc links

Pre-push hook installed.

Change-Id: I2a259ea65dd9a9094a67fdf8d78ad820abf3d7e2

src/main/java/com/google/api/gax/grpc/ApiCallSettingsTyped.java

@@ -7,7 +7,6 @@
 import io.grpc.MethodDescriptor;
 import io.grpc.Status;
 
-import java.io.IOException;
 import java.util.concurrent.ScheduledExecutorService;
 
 /**
@@ -39,7 +38,7 @@ protected ApiCallSettingsTyped(ImmutableSet<Status.Code> retryableCodes,
   }
 
   protected ApiCallable<RequestT, ResponseT> createBaseCallable(
-      ManagedChannel channel, ScheduledExecutorService executor) throws IOException {
+      ManagedChannel channel, ScheduledExecutorService executor) {
     ClientCallFactory<RequestT, ResponseT> clientCallFactory =
         new DescriptorClientCallFactory<>(methodDescriptor);
     ApiCallable<RequestT, ResponseT> callable =

src/main/java/com/google/api/gax/grpc/ApiCallable.java

@@ -46,7 +46,6 @@
 import io.grpc.Status;
 import io.grpc.StatusRuntimeException;
 
-import java.io.IOException;
 import java.util.concurrent.ScheduledExecutorService;
 
 import javax.annotation.Nullable;
@@ -104,68 +103,71 @@ public final class ApiCallable<RequestT, ResponseT> {
   private final ApiCallSettings settings;
 
   /**
-   * Create a callable object that represents a simple API method.
-   * Public only for technical reasons - for advanced usage
+   * Create a callable object that represents a simple API method. Public only for technical reasons
+   * - for advanced usage
    *
-   * @param simpleCallSettings {@link com.google.api.gax.grpc.SimpleCallSettings} to configure
-   * the method-level settings with.
-   * @param serviceSettings{@link com.google.api.gax.grpc.ServiceApiSettings}
-   * to configure the service-level settings with.
+   * @param simpleCallSettings {@link com.google.api.gax.grpc.SimpleCallSettings} to configure the
+   * method-level settings with.
+   * @param channel {@link ManagedChannel} to use to connect to the service.
+   * @param executor {@link ScheduledExecutorService} to use to when connecting to the service.
    * @return {@link com.google.api.gax.grpc.ApiCallable} callable object.
    */
   public static <RequestT, ResponseT> ApiCallable<RequestT, ResponseT> create(
       SimpleCallSettings<RequestT, ResponseT> simpleCallSettings,
-      ManagedChannel channel, ScheduledExecutorService executor) throws IOException {
+      ManagedChannel channel,
+      ScheduledExecutorService executor) {
      return simpleCallSettings.create(channel, executor);
   }
 
   /**
-   * Create a paged callable object that represents a page-streaming API method.
-   * Public only for technical reasons - for advanced usage
+   * Create a paged callable object that represents a page-streaming API method. Public only for
+   * technical reasons - for advanced usage
    *
    * @param pageStreamingCallSettings {@link com.google.api.gax.grpc.PageStreamingCallSettings} to
    * configure the page-streaming related settings with.
-   * @param serviceSettings{@link com.google.api.gax.grpc.ServiceApiSettings}
-   * to configure the service-level settings with.
+   * @param channel {@link ManagedChannel} to use to connect to the service.
+   * @param executor {@link ScheduledExecutorService} to use to when connecting to the service.
    * @return {@link com.google.api.gax.grpc.ApiCallable} callable object.
    */
   public static <RequestT, ResponseT, ResourceT>
       ApiCallable<RequestT, PageAccessor<ResourceT>> createPagedVariant(
           PageStreamingCallSettings<RequestT, ResponseT, ResourceT> pageStreamingCallSettings,
-          ManagedChannel channel, ScheduledExecutorService executor) throws IOException {
+          ManagedChannel channel,
+          ScheduledExecutorService executor) {
     return pageStreamingCallSettings.createPagedVariant(channel, executor);
   }
 
   /**
-   * Create a base callable object that represents a page-streaming API method.
-   * Public only for technical reasons - for advanced usage
+   * Create a base callable object that represents a page-streaming API method. Public only for
+   * technical reasons - for advanced usage
    *
    * @param pageStreamingCallSettings {@link com.google.api.gax.grpc.PageStreamingCallSettings} to
    * configure the page-streaming related settings with.
-   * @param serviceSettings{@link com.google.api.gax.grpc.ServiceApiSettings}
-   * to configure the service-level settings with.
+   * @param channel {@link ManagedChannel} to use to connect to the service.
+   * @param executor {@link ScheduledExecutorService} to use to when connecting to the service.
    * @return {@link com.google.api.gax.grpc.ApiCallable} callable object.
    */
-  public static <RequestT, ResponseT, ResourceT>
-      ApiCallable<RequestT, ResponseT> create(
-          PageStreamingCallSettings<RequestT, ResponseT, ResourceT> pageStreamingCallSettings,
-          ManagedChannel channel, ScheduledExecutorService executor) throws IOException {
+  public static <RequestT, ResponseT, ResourceT> ApiCallable<RequestT, ResponseT> create(
+      PageStreamingCallSettings<RequestT, ResponseT, ResourceT> pageStreamingCallSettings,
+      ManagedChannel channel,
+      ScheduledExecutorService executor) {
     return pageStreamingCallSettings.create(channel, executor);
   }
 
   /**
-   * Create a callable object that represents a bundling API method.
-   * Public only for technical reasons - for advanced usage
+   * Create a callable object that represents a bundling API method. Public only for technical
+   * reasons - for advanced usage
    *
-   * @param bundlingCallSettings {@link com.google.api.gax.grpc.BundlingSettings} to configure
-   * the bundling related settings with.
-   * @param serviceSettings{@link com.google.api.gax.grpc.ServiceApiSettings}
-   * to configure the service-level settings with.
+   * @param bundlingCallSettings {@link com.google.api.gax.grpc.BundlingSettings} to configure the
+   * bundling related settings with.
+   * @param channel {@link ManagedChannel} to use to connect to the service.
+   * @param executor {@link ScheduledExecutorService} to use to when connecting to the service.
    * @return {@link com.google.api.gax.grpc.ApiCallable} callable object.
    */
   public static <RequestT, ResponseT> ApiCallable<RequestT, ResponseT> create(
       BundlingCallSettings<RequestT, ResponseT> bundlingCallSettings,
-      ManagedChannel channel, ScheduledExecutorService executor) throws IOException {
+      ManagedChannel channel,
+      ScheduledExecutorService executor) {
     return bundlingCallSettings.create(channel, executor);
   }
 

src/main/java/com/google/api/gax/grpc/BundlingCallSettings.java

@@ -7,7 +7,6 @@
 import io.grpc.MethodDescriptor;
 import io.grpc.Status;
 
-import java.io.IOException;
 import java.util.Set;
 import java.util.concurrent.ScheduledExecutorService;
 
@@ -24,8 +23,8 @@ public final class BundlingCallSettings<RequestT, ResponseT>
   /**
    * Package-private, for use by ApiCallable.
    */
-  ApiCallable<RequestT, ResponseT> create(ManagedChannel channel, ScheduledExecutorService executor)
-      throws IOException {
+  ApiCallable<RequestT, ResponseT> create(
+      ManagedChannel channel, ScheduledExecutorService executor) {
     ApiCallable<RequestT, ResponseT> baseCallable = createBaseCallable(channel, executor);
     bundlerFactory = new BundlerFactory<>(bundlingDescriptor, bundlingSettings);
     return baseCallable.bundling(bundlingDescriptor, bundlerFactory);

src/main/java/com/google/api/gax/grpc/ChannelProvider.java

@@ -17,11 +17,11 @@
  * Implementations of {@link ChannelProvider} may choose to create a new {@link ManagedChannel} for
  * each call to {@link #getChannel}, or may return a fixed {@link ManagedChannel} instance. In cases
  * where the same {@link ManagedChannel} instance is returned, for example by a
- * {@link ChannelProvider} created using the
- * {@link ServiceApiSettings#provideChannelWith(ManagedChannel, boolean)} method, and
- * shouldAutoClose returns true, the {@link #getChannel} method will throw an
- * {@link OperationNotSupportedException} if it is called more than once. This is to prevent the
- * same {@link ManagedChannel} being closed prematurely when it is used by multiple client objects.
+ * {@link ChannelProvider} created using the {@link ServiceApiSettings}
+ * provideChannelWith(ManagedChannel, boolean) method, and shouldAutoClose returns true, the
+ * {@link #getChannel} method will throw an {@link OperationNotSupportedException} if it is called
+ * more than once. This is to prevent the same {@link ManagedChannel} being closed prematurely when
+ * it is used by multiple client objects.
  */
 public interface ChannelProvider {
   /**

src/main/java/com/google/api/gax/grpc/ExecutorProvider.java

@@ -11,12 +11,11 @@
  * Implementations of ExecutorProvider may choose to create a new {@link ScheduledExecutorService}
  * for each call to {@link #getExecutor}, or may return a fixed {@link ScheduledExecutorService}
  * instance. In cases where the same {@link ScheduledExecutorService} instance is returned, for
- * example by an {@link ExecutorProvider} created using the
- * {@link ServiceApiSettings#provideExecutorWith(ScheduledExecutorService, boolean)} method, and
- * shouldAutoClose returns true, the {@link #getExecutor} method will throw an
- * {@link OperationNotSupportedException} if it is called more than once. This is to prevent the
- * same {@link ScheduledExecutorService} being closed prematurely when it is used by multiple client
- * objects.
+ * example by an {@link ExecutorProvider} created using the {@link ServiceApiSettings}
+ * provideExecutorWith(ScheduledExecutorService, boolean) method, and shouldAutoClose returns true,
+ * the {@link #getExecutor} method will throw an {@link OperationNotSupportedException} if it is
+ * called more than once. This is to prevent the same {@link ScheduledExecutorService} being closed
+ * prematurely when it is used by multiple client objects.
  */
 public interface ExecutorProvider {
   /**

src/main/java/com/google/api/gax/grpc/PageStreamingCallSettings.java

@@ -8,7 +8,6 @@
 import io.grpc.MethodDescriptor;
 import io.grpc.Status;
 
-import java.io.IOException;
 import java.util.Set;
 import java.util.concurrent.ScheduledExecutorService;
 
@@ -24,16 +23,16 @@ public final class PageStreamingCallSettings<RequestT, ResponseT, ResourceT>
   /**
    * Package-private, for use by ApiCallable.
    */
-  ApiCallable<RequestT, ResponseT> create(ManagedChannel channel, ScheduledExecutorService executor)
-      throws IOException {
+  ApiCallable<RequestT, ResponseT> create(
+      ManagedChannel channel, ScheduledExecutorService executor) {
     return createBaseCallable(channel, executor);
   }
 
   /**
    * Package-private, for use by ApiCallable.
    */
   ApiCallable<RequestT, PageAccessor<ResourceT>> createPagedVariant(
-      ManagedChannel channel, ScheduledExecutorService executor) throws IOException {
+      ManagedChannel channel, ScheduledExecutorService executor) {
     ApiCallable<RequestT, ResponseT> baseCallable = createBaseCallable(channel, executor);
     return baseCallable.pageStreaming(pageDescriptor);
   }

src/main/java/com/google/api/gax/grpc/SimpleCallSettings.java

@@ -7,7 +7,6 @@
 import io.grpc.MethodDescriptor;
 import io.grpc.Status;
 
-import java.io.IOException;
 import java.util.Set;
 import java.util.concurrent.ScheduledExecutorService;
 
@@ -21,8 +20,8 @@ public final class SimpleCallSettings<RequestT, ResponseT>
   /**
    * Package-private, for use by ApiCallable.
    */
-  ApiCallable<RequestT, ResponseT> create(ManagedChannel channel, ScheduledExecutorService executor)
-      throws IOException {
+  ApiCallable<RequestT, ResponseT> create(
+      ManagedChannel channel, ScheduledExecutorService executor) {
     return createBaseCallable(channel, executor);
   }