Class GetIndexesRequestChecker (2.0.0)

public class GetIndexesRequestChecker

Checks values of com.google.appengine.api.search.GetIndexesRequest.

Inheritance

java.lang.Object > GetIndexesRequestChecker

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

checkIndexNamePrefix(String indexNamePrefix)

public static String checkIndexNamePrefix(String indexNamePrefix)

Checks whether the given index name prefix is legal. This method uses the same checks as IndexChecker#checkName(String).

Parameter
Name	Description
indexNamePrefix	String the index name prefix to be checked

Returns
Type	Description
String	the checked index name prefix

checkLimit(int limit)

public static int checkLimit(int limit)

Checks whether the number of indexes to return is between 1 and the maximum.

Parameter
Name	Description
limit	int the maximum number of indexes to return in list results

Returns
Type	Description
int	the checked number of indexes to return

checkListIndexesParams(SearchServicePb.ListIndexesParams params)

public static SearchServicePb.ListIndexesParams checkListIndexesParams(SearchServicePb.ListIndexesParams params)

Ensures the given protocol buffer parameters are valid. If any of the parameters fail to pass the checks, this method throws IllegalArgumentException. If everything is valid the original parameters are returned.

Parameter
Name	Description
params	com.google.appengine.api.search.proto.SearchServicePb.ListIndexesParams the parameters to be checked for validity

Returns
Type	Description
com.google.appengine.api.search.proto.SearchServicePb.ListIndexesParams	the checked parameters for listing indexes

checkOffset(int offset)

public static int checkOffset(int offset)

Checks whether the offset of the first indexes to return is between 0 and the maximum.

Parameter
Name	Description
offset	int the offset of the first index to return in list results

Returns
Type	Description
int	the checked offset of the first index to return

checkStartIndexName(String startIndexName)

public static String checkStartIndexName(String startIndexName)

Checks whether the given start index name is legal. This method uses the same checks as IndexChecker#checkName(String).

Parameter
Name	Description
startIndexName	String the name of the first index to be returned

Returns
Type	Description
String	the checked start index name

Constructors

GetIndexesRequestChecker()

public GetIndexesRequestChecker()