com.vendasta.sales.v1.internal.BusinessPagedResponseMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sales.v1 Show documentation
Java SDK for service sales
The newest version!
package com.vendasta.sales.v1.internal;

import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.util.Map;
import java.util.HashMap;
import java.util.Collections;
import java.util.Arrays;
import org.apache.commons.lang3.StringUtils;
import com.vendasta.sales.v1.generated.BusinessProto;

/**
 * Contains metadata about the paged response
 **/
public final class BusinessPagedResponseMetadata {




	private final String nextCursor;
	private final boolean hasMore;
	private final long totalResults;
	

	private BusinessPagedResponseMetadata (
		final String nextCursor,
		final boolean hasMore,
		final long totalResults)
		
	{
		this.nextCursor = nextCursor;
		this.hasMore = hasMore;
		this.totalResults = totalResults;
		
	}
	
	/**
	 * A cursor that can be provided to retrieve the next page of results
      * @return The final value of nextCursor on the object
	 **/
	public String getNextCursor() {
		return this.nextCursor;
	}
	
	/**
	 * Whether or not more results exist
      * @return The final value of hasMore on the object
	 **/
	public boolean getHasMore() {
		return this.hasMore;
	}
	
	/**
	 * The total number of results for this query across all pages
      * @return The final value of totalResults on the object
	 **/
	public long getTotalResults() {
		return this.totalResults;
	}
	

	public static class Builder {
		private String nextCursor;
		private boolean hasMore;
		private long totalResults;
		
		public Builder() {
			this.nextCursor = "";
			this.hasMore = false;
			this.totalResults = 0;
			
		}
		
		/**
		  * Adds a value to the builder for nextCursor
		  * @param nextCursor Value to assign to the mutable Builder
		  * @return The Builder instance so that call chaining works
		 **/
		public Builder setNextCursor(String nextCursor) {
			this.nextCursor = nextCursor;
			return this;
		}
		
		/**
		  * Adds a value to the builder for hasMore
		  * @param hasMore Value to assign to the mutable Builder
		  * @return The Builder instance so that call chaining works
		 **/
		public Builder setHasMore(boolean hasMore) {
			this.hasMore = hasMore;
			return this;
		}
		
		/**
		  * Adds a value to the builder for totalResults
		  * @param totalResults Value to assign to the mutable Builder
		  * @return The Builder instance so that call chaining works
		 **/
		public Builder setTotalResults(long totalResults) {
			this.totalResults = totalResults;
			return this;
		}
		
		/**
		  * Takes the configuration in the mutable Builder and uses it to instantiate a final instance
		  * of the BusinessPagedResponseMetadata class
		  * @return The instantiated final BusinessPagedResponseMetadata
		 **/
		public BusinessPagedResponseMetadata build() {
			return new BusinessPagedResponseMetadata(
				this.nextCursor,
				this.hasMore,
				this.totalResults);
		}
	}

	/**
	 * Returns a Builder for BusinessPagedResponseMetadata, which is a mutable representation of the object.  Once the
	 * client has built up an object they can then create an immutable BusinessPagedResponseMetadata object using the
	 * build function.
	 * @return A fresh Builder instance with no values set
	 **/
	public static Builder newBuilder() {
		return new Builder();
	}

	/**
	 * Provides a human-readable representation of this object.  Useful for debugging.
	 * @return A string representation of the BusinessPagedResponseMetadata instance
	 **/
	 public String toString() {
		 String result = "BusinessPagedResponseMetadata\n";
		 result += "-> nextCursor: (String)"
		     + StringUtils.join("\n  ", Arrays.asList(String.valueOf(this.nextCursor).split("\n"))) + "\n"; 
		 result += "-> hasMore: (boolean)"
		     + StringUtils.join("\n  ", Arrays.asList(String.valueOf(this.hasMore).split("\n"))) + "\n"; 
		 result += "-> totalResults: (long)"
		     + StringUtils.join("\n  ", Arrays.asList(String.valueOf(this.totalResults).split("\n"))) + "\n"; 
		 
		 return result;
	 }
	/**
	* Allows for simple conversion between the low-level generated protobuf object to
	* BusinessPagedResponseMetadata, which is much more usable.
	* @return An instance of BusinessPagedResponseMetadata representing the input proto object
	**/
	public static BusinessPagedResponseMetadata fromProto(BusinessProto.BusinessPagedResponseMetadata proto) {
		BusinessPagedResponseMetadata out = null;
		if (proto != null) {
			BusinessPagedResponseMetadata.Builder outBuilder = BusinessPagedResponseMetadata.newBuilder()
			.setNextCursor(proto.getNextCursor())
			.setHasMore(proto.getHasMore())
			.setTotalResults(proto.getTotalResults());
			out = outBuilder.build();
		}
		return out;
	}

	/**
	* Convenience method for handling lists of proto objects.  It calls .fromProto on each one
	* and returns a list of the converted results.
	* @return A list of BusinessPagedResponseMetadata instances representing the input proto objects
	**/
	public static List fromProtos(List protos) {
		List out = new ArrayList();
		for(BusinessProto.BusinessPagedResponseMetadata proto : protos) {
			out.add(BusinessPagedResponseMetadata.fromProto(proto));
		}
		return out;
	}

	/**
	 * Allows for simple conversion of an object to the low-level generated protobuf object.
	 * @return An instance of BusinessProto.BusinessPagedResponseMetadata which is a proto object ready for wire transmission
	 **/
	 public BusinessProto.BusinessPagedResponseMetadata toProto() {
		 BusinessPagedResponseMetadata obj = this;
		 BusinessProto.BusinessPagedResponseMetadata.Builder outBuilder = BusinessProto.BusinessPagedResponseMetadata.newBuilder();
		 outBuilder.setNextCursor(obj.getNextCursor());
		 outBuilder.setHasMore(obj.getHasMore());
		 outBuilder.setTotalResults(obj.getTotalResults());
		 return outBuilder.build();
	 }

	 /**
	  * Convenience method for handling lists of objects.  It calls .toProto on each one and
	  * returns a list of the converted results.
	  * @return A list of BusinessProto.BusinessPagedResponseMetadata instances representing the input objects.
	  */
	public static List toProtos(List objects) {
		List out = new ArrayList();
		if(objects != null) {
			for (BusinessPagedResponseMetadata obj : objects) {
				out.add(obj!=null?obj.toProto():null);
			}
		}
		return out;
	}
}