diff --git a/src/main/java/com/smartystreets/api/us_street/Batch.java b/src/main/java/com/smartystreets/api/us_street/Batch.java index 3f0a5c0..bc01fbb 100644 --- a/src/main/java/com/smartystreets/api/us_street/Batch.java +++ b/src/main/java/com/smartystreets/api/us_street/Batch.java @@ -10,7 +10,7 @@ /** * This class contains a collection of lookups to be sent to the
* SmartyStreets US Street API all at once. This is more efficient than sending them
- * one at a time. + * one at a time. Maximum batch size is 100. */ public class Batch { public static final int MAX_BATCH_SIZE = 100; @@ -23,7 +23,7 @@ public Batch() { } /** - * + * Adds a lookup to the batch, as long as there are less than 100 lookup in the batch already. * @param newAddress * @throws BatchFullException Batch size cannot exceed 100 */ diff --git a/src/main/java/com/smartystreets/api/us_street/Client.java b/src/main/java/com/smartystreets/api/us_street/Client.java index 3b66452..7c6f2ed 100644 --- a/src/main/java/com/smartystreets/api/us_street/Client.java +++ b/src/main/java/com/smartystreets/api/us_street/Client.java @@ -28,7 +28,7 @@ public void send(Lookup lookup) throws SmartyException, IOException { } /** - * + * Sends a batch of up to 100 lookups for validation. * @param batch Batch must contain between 1 and 100 Lookup objects * @throws SmartyException * @throws IOException diff --git a/src/main/java/com/smartystreets/api/us_zipcode/Batch.java b/src/main/java/com/smartystreets/api/us_zipcode/Batch.java index 84a3577..a1f99b2 100644 --- a/src/main/java/com/smartystreets/api/us_zipcode/Batch.java +++ b/src/main/java/com/smartystreets/api/us_zipcode/Batch.java @@ -8,7 +8,7 @@ import java.util.Vector; /** - * This class contains a collection of lookups to be sent to the SmartyStreets US ZIP Code API
+ * This class contains a collection of up to 100 lookups to be sent to the SmartyStreets US ZIP Code API
* all at once. This is more efficient than sending them one at a time. */ public class Batch { diff --git a/src/main/java/com/smartystreets/api/us_zipcode/Client.java b/src/main/java/com/smartystreets/api/us_zipcode/Client.java index 3f7faae..4fbd39d 100644 --- a/src/main/java/com/smartystreets/api/us_zipcode/Client.java +++ b/src/main/java/com/smartystreets/api/us_zipcode/Client.java @@ -27,6 +27,12 @@ public void send(Lookup lookup) throws SmartyException, IOException { send(batch); } + /** + * Sends a batch of up to 100 lookups for validation. + * @param batch Batch must contain between 1 and 100 Lookup objects + * @throws SmartyException + * @throws IOException + */ public void send(Batch batch) throws SmartyException, IOException { Request request = new Request();