Fixed documentation and null returns from rpc.

mderka · mderka · commit 896de75d1cad · 2016-02-03T14:34:38.000-08:00
diff --git a/gcloud-java-dns/src/main/java/com/google/gcloud/spi/DefaultDnsRpc.java b/gcloud-java-dns/src/main/java/com/google/gcloud/spi/DefaultDnsRpc.java
@@ -30,6 +30,7 @@
  */
 public class DefaultDnsRpc implements DnsRpc {
 
+  private static final String SORTING_KEY = "changeSequence";
   private final Dns dns;
   private final DnsOptions options;
 
@@ -64,9 +65,14 @@ public ManagedZone getZone(String zoneName, Map<Option, ?> options) throws DnsEx
     // just fields option
     try {
       return dns.managedZones().get(this.options.projectId(), zoneName)
-          .setFields(FIELDS.getString(options)).execute();
+          .setFields(FIELDS.getString(options))
+          .execute();
     } catch (IOException ex) {
-      throw translate(ex);
+      DnsException serviceException = translate(ex);
+      if (serviceException.code() == HTTP_NOT_FOUND) {
+        return null;
+      }
+      throw serviceException;
     }
   }
 
@@ -151,7 +157,16 @@ public Change getChangeRequest(String zoneName, String changeRequestId, Map<Opti
           .setFields(FIELDS.getString(options))
           .execute();
     } catch (IOException ex) {
-      throw translate(ex);
+      DnsException serviceException = translate(ex);
+      if (serviceException.code() == HTTP_NOT_FOUND) {
+        // message format "The 'parameters.changeId' resource named '4' does not exist."
+        if (serviceException.getMessage().contains("changeId")) {
+          // the change id was not found, but the zone exists
+          return null;
+        }
+        // the zone does not exist, so throw an exception
+      }
+      throw serviceException;
     }
   }
 
@@ -165,9 +180,8 @@ public Tuple<String, Iterable<Change>> listChangeRequests(String zoneName, Map<O
           .setMaxResults(PAGE_SIZE.getInt(options))
           .setPageToken(PAGE_TOKEN.getString(options));
       if (SORTING_ORDER.getString(options) != null) {
-        // this needs to be checked and changed if more sorting options are implemented, issue #604
-        String key = "changeSequence";
-        request = request.setSortBy(key).setSortOrder(SORTING_ORDER.getString(options));
+        // todo check and change if more sorting options are implemented, issue #604
+        request = request.setSortBy(SORTING_KEY).setSortOrder(SORTING_ORDER.getString(options));
       }
       ChangesListResponse response = request.execute();
       return Tuple.<String, Iterable<Change>>of(response.getNextPageToken(), response.getChanges());
diff --git a/gcloud-java-dns/src/main/java/com/google/gcloud/spi/DnsRpc.java b/gcloud-java-dns/src/main/java/com/google/gcloud/spi/DnsRpc.java
@@ -85,7 +85,7 @@ public Y y() {
    * Creates a new zone.
    *
    * @param zone a zone to be created
-   * @return Updated {@link ManagedZone} object
+   * @return Updated {@code ManagedZone} object
    * @throws DnsException upon failure
    */
   ManagedZone create(ManagedZone zone) throws DnsException;
@@ -121,7 +121,7 @@ public Y y() {
    *
    * @param zoneName name of the zone to be listed
    * @param options a map of options for the service call
-   * @throws DnsException upon failure or if zone not found
+   * @throws DnsException upon failure or if zone was not found
    */
   Tuple<String, Iterable<ResourceRecordSet>> listDnsRecords(String zoneName,
       Map<Option, ?> options) throws DnsException;
@@ -131,40 +131,40 @@ Tuple<String, Iterable<ResourceRecordSet>> listDnsRecords(String zoneName,
    * 
    * @param options a map of options for the service call
    * @return up-to-date project information
-   * @throws DnsException upon failure
+   * @throws DnsException upon failure or if the project is not found
    */
   Project getProject(Map<Option, ?> options) throws DnsException;
 
   /**
    * Applies change request to a zone. 
    *
-   * @param zoneName the name of a zone to which the {@link Change} should be applied
+   * @param zoneName the name of a zone to which the {@code Change} should be applied
    * @param changeRequest change to be applied
    * @param options a map of options for the service call
    * @return updated change object with server-assigned ID
-   * @throws DnsException upon failure or if zone not found
+   * @throws DnsException upon failure or if zone was not found
    */
   Change applyChangeRequest(String zoneName, Change changeRequest, Map<Option, ?> options) 
       throws DnsException;
 
   /**
    * Returns an existing change request.
    *
-   * @param zoneName the name of a zone to which the {@link Change} was be applied
+   * @param zoneName the name of a zone to which the {@code Change} was be applied
    * @param changeRequestId the unique id assigned to the change by the server
    * @param options a map of options for the service call
-   * @return up-to-date change object
-   * @throws DnsException upon failure or if zone not found
+   * @return up-to-date change object or {@code null} if change was not found
+   * @throws DnsException upon failure or if zone was not found
    */
   Change getChangeRequest(String zoneName, String changeRequestId, Map<Option, ?> options) 
       throws DnsException;
 
   /**
-   * List an existing change requests for a zone.
+   * List existing change requests for a zone.
    *
-   * @param zoneName the name of a zone to which the {@link Change}s were be applied
+   * @param zoneName the name of a zone to which the {@code Change}s were be applied
    * @param options a map of options for the service call
-   * @throws DnsException upon failure or if zone not found
+   * @throws DnsException upon failure or if zone was not found
    */
   Tuple<String, Iterable<Change>> listChangeRequests(String zoneName, Map<Option, ?> options) 
       throws DnsException;
