Finished javadoc update (no warnings)

Author: TealOcean

src/main/java/com/blockscore/common/BlockscoreErrorType.java

@@ -17,6 +17,7 @@ private BlockscoreErrorType(@NotNull final String value) {
 
     /**
      * Returns if this status matches.
+     * @param value Value to test
      * @return True or false.
      */
     public boolean isEqualTo(final String value) {

src/main/java/com/blockscore/common/CorporationType.java

@@ -17,6 +17,7 @@ private CorporationType(@NotNull final String value) {
 
     /**
      * Returns if this matches.
+     * @param value Value to test
      * @return True or false.
      */
     public boolean isEqualTo(final String value) {

src/main/java/com/blockscore/common/ValidationErrorType.java

@@ -17,6 +17,7 @@ private ValidationErrorType(@NotNull final String value) {
 
     /**
      * Returns if this matches.
+     * @param value Value to test
      * @return True or false.
      */
     public boolean isEqualTo(final String value) {

src/main/java/com/blockscore/common/ValidityStatus.java

@@ -17,6 +17,7 @@ private ValidityStatus(@NotNull final String value) {
 
     /**
      * Returns if this matches.
+     * @param value Value to test.
      * @return True or false.
      */
     public boolean isEqualTo(final String value) {

src/main/java/com/blockscore/models/AnsweredQuestion.java

@@ -25,6 +25,7 @@ public AnsweredQuestion(int questionId, int answerId) {
     /**
      * Sets the question ID.
      * @param questionId Question ID
+     * @return this
      */
     public AnsweredQuestion setQuestionId(final int questionId) {
         mQuestionId = questionId;
@@ -34,6 +35,7 @@ public AnsweredQuestion setQuestionId(final int questionId) {
     /**
      * Sets the answer ID.
      * @param answerId ID associated with answer.
+     * @return this
      */
     public AnsweredQuestion setAnswerId(final int answerId) {
         mAnswerId = answerId;

src/main/java/com/blockscore/models/Company.java

@@ -95,6 +95,7 @@ public String getEntityName() {
     /**
      * Name of entity. This should exclude any legal endings like "Co" or "Inc" for best results.
      * @param entityName Name
+     * @return this.
      */
     @NotNull
     public Company setEntityName(@NotNull final String entityName) {
@@ -115,6 +116,7 @@ public String getTaxId() {
      * Sets the Tax ID for this entity. The tax ID should only include the digits of the ID with
      * no extraneous characters like dashes.
      * @param taxId Tax ID
+     * @return this.
      */
     @NotNull
     public Company setTaxId(@NotNull final String taxId) {
@@ -137,6 +139,7 @@ public Date getIncorpDate() {
     /**
      * Sets the incorporation date. Should be of the ISO date form (YYYY-MM-DD)
      * @param incorpDate Incorporation date.
+     * @return this.
      */
     @NotNull
     public Company setIncorpDate(@NotNull final Date incorpDate) {
@@ -159,6 +162,7 @@ public String getIncorpState() {
     /**
      * Sets the incorporation state. Can be either of ISO code form or the full length name of the state.
      * @param incorpState Incorporation state.
+     * @return this.
      */
     @NotNull
     public Company setIncorpState(@NotNull final String incorpState) {
@@ -178,6 +182,7 @@ public String getIncorpCountryCode() {
     /**
      * Sets the incorporation country code. Should be of the ISO alpha-2 code form.
      * @param incorpCountryCode Country code.
+     * @return this.
      */
     @NotNull
     public Company setIncorpCountryCode(@NotNull final String incorpCountryCode) {
@@ -198,6 +203,7 @@ public CorporationType getIncorpType() {
     /**
      * Sets the corporation type.
      * @param incorpType Corporation type.
+     * @return this.
      */
     public Company setIncorpType(@NotNull final CorporationType incorpType) {
         mIncorpType = incorpType.toString();
@@ -216,6 +222,7 @@ public String[] getDbas() {
     /**
      * Sets the "doing business as" names.
      * @param dbas Doing business as names.
+     * @return this.
      */
     public Company setDbas(@NotNull final String dbas) {
         mDbas = dbas;
@@ -235,6 +242,7 @@ public String getRegNumber() {
     /**
      * Sets the registration number for this entity.
      * @param regNumber Registration number.
+     * @return this.
      */
     public Company setRegNumber(@NotNull final String regNumber) {
         mRegNumber = regNumber;
@@ -253,6 +261,7 @@ public String getEmail() {
     /**
      * Sets the email for this entity.
      * @param email Email for the entity.
+     * @return this.
      */
     public Company setEmail(@NotNull final String email) {
         mEmail = email;
@@ -271,6 +280,7 @@ public String getURL() {
     /**
      * Sets the URL for this business.
      * @param url URL for the business
+     * @return this.
      */
     public Company setURL(@NotNull final String url) {
         mURL = url;
@@ -329,6 +339,7 @@ public Address getAddress() {
     /**
      * Sets the address of the entity.
      * @param address Address to use.
+     * @return this.
      */
     public Company setAddress(@NotNull Address address) {
         mAddress = address;

src/main/java/com/blockscore/models/WatchlistCandidate.java

@@ -78,6 +78,7 @@ public String getNote() {
      * Sets an additional field which can be used for arbitrary storage. is typically used for
      * storing your internal identifiers for customer.
      * @param note Note to store.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setNote(@Nullable final String note) {
@@ -97,6 +98,7 @@ public String getSSN() {
     /**
      * Can be either the last 4 digits of the US Social Security Number or the whole SSN.
      * @param ssn SSN to use.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setSSN(@Nullable final String ssn) {
@@ -116,6 +118,7 @@ public String getPassport() {
     /**
      * Sets the passport number of the individual being verified. is only used for verifying non-US customers.
      * @param passport Passport data.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setPassport(@Nullable final String passport) {
@@ -138,6 +141,7 @@ public Date getDateOfBirth() {
     /**
      * Set the date of birth of your candidate.
      * @param dateOfBirth Date of birth
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setDateOfBirth(@Nullable final Date dateOfBirth) {
@@ -160,6 +164,7 @@ public String getFirstName() {
     /**
      * Sets the legal first name of the customer.
      * @param firstName First name.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setFirstName(@NotNull final String firstName) {
@@ -179,6 +184,7 @@ public String getMiddleName() {
     /**
      * Sets the legal middle name of the customer.
      * @param middleName Middle name.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setMiddleName(@NotNull final String middleName) {
@@ -198,6 +204,7 @@ public String getLastName() {
     /**
      * Sets the legal last name.
      * @param lastName Last name.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setLastName(@NotNull final String lastName) {
@@ -217,6 +224,7 @@ public String getStreet1() {
     /**
      * Sets the primary street address of the customer. This is automatically normalized.
      * @param street1 Street address.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setStreet1(@NotNull final String street1) {
@@ -236,6 +244,7 @@ public String getStreet2() {
     /**
      * Sets the second address line typically used for apartment or suite numbers. This is automatically normalized.
      * @param street2 Street address (line 2)
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setStreet2(@NotNull final String street2) {
@@ -255,6 +264,7 @@ public String getCity() {
     /**
      * Sets the city name of the customer. This is automatically normalized.
      * @param city City name.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setCity(@NotNull final String city) {
@@ -274,6 +284,7 @@ public String getState() {
     /**
      * Sets the state of the customer. Should be of the FIPS code form. For example California would be CA.
      * @param state State
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setState(@Nullable final String state) {
@@ -293,6 +304,7 @@ public String getPostalCode() {
     /**
      * Sets the postal code.
      * @param postalCode Postal code.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setPostalCode(@Nullable final String postalCode) {
@@ -312,6 +324,7 @@ public String getCountryCode() {
     /**
      * Sets the country of the customer. Should be of the ISO code form.
      * @param countryCode Country code.
+     * @return this.
      */
     @NotNull
     public WatchlistCandidate setCountryCode(@Nullable final String countryCode) {

src/main/java/com/blockscore/net/BlockscoreApiClient.java

@@ -59,6 +59,7 @@ public static void init(@NotNull final String apiKey) {
 
     /**
      * Turns on/off logging. Should be done after init(), but before API client usage.
+     * @param useVerboseLogs True to use verbose network logs.
      */
     public static void useVerboseLogs(final boolean useVerboseLogs) {
         if (useVerboseLogs) {
@@ -198,6 +199,7 @@ public void scoreQuestionSet(@NotNull final String questionSetId
      * @see com.blockscore.net.BlockscoreRetrofitAPI#scoreQuestionSet(String, com.blockscore.models.request.AnswerRequest)
      * @param questionSetId Question set ID
      * @param answers Answers to questions
+     * @return Observable containing the question set.
      */
     @NotNull
     public Observable<QuestionSet> scoreQuestionSet(@NotNull final String questionSetId
@@ -345,6 +347,7 @@ public void updateWatchlistCandidate(@NotNull final String id, @NotNull final Wa
      * @see com.blockscore.net.BlockscoreRetrofitAPI#updateWatchlistCandidate(String, com.blockscore.models.WatchlistCandidate)
      * @param id ID for the candidate.
      * @param candidate Watchlist candidate to create.
+     * @return Observable containing the candidate.
      */
     @NotNull
     public Observable<WatchlistCandidate> updateWatchlistCandidate(@NotNull final String id
@@ -366,6 +369,7 @@ public void getWatchlistCandidate(@NotNull final String id, @NotNull final Callb
      * Gets a watchlist candidate.
      * @see com.blockscore.net.BlockscoreRetrofitAPI#getWatchlistCandidate(String)
      * @param id ID for the candidate.
+     * @return Obsercable containing the candidate
      */
     @NotNull
     public Observable<WatchlistCandidate> getWatchlistCandidate(@NotNull final String id) {
@@ -375,6 +379,7 @@ public Observable<WatchlistCandidate> getWatchlistCandidate(@NotNull final Strin
     /**
      * Lists the watchlist candidates.
      * @see BlockscoreRetrofitAPI#listWatchlistCandidate(retrofit.Callback)
+     * @param callback Callback to use.
      */
     public void listWatchlistCandidate(@NotNull final Callback<List<WatchlistCandidate>> callback) {
         mRestAdapter.listWatchlistCandidate(callback);
@@ -403,6 +408,7 @@ public void getWatchlistCandidateHistory(@NotNull final String id
     /**
      * Gets the watchlist candidate's history.
      * @param id ID for the candidate.
+     * @return Observable containing a list of watchlist candidates.
      */
     @NotNull
     public Observable<List<WatchlistCandidate>> getWatchlistCandidateHistory(@NotNull final String id) {
@@ -422,6 +428,7 @@ public void deleteWatchlistCandidate(@NotNull final String id
     /**
      * Deletes a watchlist candidate.
      * @param id ID for the candidate.
+     * @return Observable containing the watchlist candidate.
      */
     @NotNull
     public Observable<WatchlistCandidate> deleteWatchlistCandidate(@NotNull final String id) {
@@ -441,6 +448,7 @@ public void getWatchlistCandidateHits(@NotNull final String id
     /**
      * Gets the hits for a watchlist candidate.
      * @param id ID for the candidate.
+     * @return Observable containing the list of watchlist hits.
      */
     @NotNull
     public Observable<List<WatchlistHit>> getWatchlistCandidateHits(@NotNull final String id) {
@@ -460,6 +468,7 @@ public void searchWatchlists(@NotNull final SearchRequest searchRequest
     /**
      * Searches watchlists for a given candidate.
      * @param searchRequest Search request to complete
+     * @return Observable containing the watch list search results.
      */
     @NotNull
     public Observable<WatchlistSearchResults> searchWatchlists(@NotNull final SearchRequest searchRequest) {

src/main/java/com/blockscore/net/BlockscoreRetrofitAPI.java

@@ -59,6 +59,7 @@ public interface BlockscoreRetrofitAPI {
      * took place along with all of its associated data. </p>
      * Thread: Any [Determined by settings on Observable]
      * @param id ID of verification to verify.
+     * @return Observable containing a verification.
      */
     @NotNull
     @GET("/verifications/{id}")
@@ -77,6 +78,7 @@ public interface BlockscoreRetrofitAPI {
      * <p>Gets a list of historical records for all verifications you have completed. Sorted
      * newest to oldest. </p>
      * Thread: Any [Determined by settings on Observable]
+     * @return Observable containing a list of verifications.
      */
     @NotNull
     @GET("/verifications")
@@ -100,6 +102,7 @@ void createQuestionSet(@NotNull @Body final QuestionSetRequest request
      * is presented in will be randomized. </p>
      * Thread: Any [Determined by settings on Observable]
      * @param request Question set request.
+     * @return Observable containing a question set
      */
     @NotNull
     @POST("/questions")
@@ -109,6 +112,7 @@ void createQuestionSet(@NotNull @Body final QuestionSetRequest request
      * <p>The scoring system will score it based on how many questions you submit, so if you would only like
      * to ask 3 questions, only submit the 3 questions which you would like scored. </p>
      * Thread: Asynchronous
+     * @param questionSetId Question set ID.
      * @param answers Question set request.
      * @param callback Callback to use.
      */
@@ -121,6 +125,7 @@ void scoreQuestionSet(@Path("id") @NotNull final String questionSetId
      * <p>The scoring system will score it based on how many questions you submit, so if you would only like
      * to ask 3 questions, only submit the 3 questions which you would like scored. </p>
      * Thread: Any [Determined by settings on Observable]
+     * @param questionSetId Question set ID.
      * @param answers Question set request.
      * @return Observable containing the question set
      */