Package org.codelibs.fess.app.web.api

Class ApiResult.ApiConfigsResponse<T>

java.lang.Object

org.codelibs.fess.app.web.api.ApiResult.ApiResponse

org.codelibs.fess.app.web.api.ApiResult.ApiConfigsResponse<T>

Type Parameters:

T - the type of the configuration settings

Enclosing class:

ApiResult

public static class ApiResult.ApiConfigsResponse<T>
extends ApiResult.ApiResponse

Represents an API response for a list of configuration settings.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<T>	settings	The list of configuration settings.
protected long	total	The total number of configuration settings.

Fields inherited from class org.codelibs.fess.app.web.api.ApiResult.ApiResponse

status, version

Constructor Summary

Constructors

Constructor	Description
ApiConfigsResponse()	Constructs an empty ApiConfigsResponse.

Method Summary

Modifier and Type	Method	Description
ApiResult	result()	Returns a new ApiResult instance with this ApiResponse.
ApiResult.ApiConfigsResponse<T>	settings(List<T> settings)	Sets the list of configuration settings and updates the total count.
ApiResult.ApiConfigsResponse<T>	total(long total)	Sets the total number of configuration settings.

Methods inherited from class org.codelibs.fess.app.web.api.ApiResult.ApiResponse

status

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

settings

protected List<T> settings

The list of configuration settings.

total

protected long total

The total number of configuration settings.

Constructor Details

ApiConfigsResponse

public ApiConfigsResponse()

Constructs an empty ApiConfigsResponse.

Method Details

settings

public ApiResult.ApiConfigsResponse<T> settings(List<T> settings)

Sets the list of configuration settings and updates the total count.

Parameters:

settings - The list of configuration settings.

Returns:

The ApiConfigsResponse instance.

total

public ApiResult.ApiConfigsResponse<T> total(long total)

Sets the total number of configuration settings.

Parameters:

total - The total number of configuration settings.

Returns:

The ApiConfigsResponse instance.

result

public ApiResult result()

Description copied from class: ApiResult.ApiResponse

Returns a new ApiResult instance with this ApiResponse.

Overrides:

result in class ApiResult.ApiResponse

Returns:

A new ApiResult instance.