io.katharsis.resource

Enum RestrictedQueryParamsMembers

java.lang.Object

java.lang.Enum<RestrictedQueryParamsMembers>

io.katharsis.resource.RestrictedQueryParamsMembers

All Implemented Interfaces:

Serializable, Comparable<RestrictedQueryParamsMembers>

public enum RestrictedQueryParamsMembers
extends Enum<RestrictedQueryParamsMembers>

Enum Constant Summary

Enum Constants

Enum Constant and Description
fields List of specified fields to include in models
filter Set of collection's fields used for filtering
group Field to group by the collection
include Additional resources that should be attached to response
page Pagination properties
sort Set of collection's fields used for sorting

Method Summary

Modifier and Type	Method and Description
static RestrictedQueryParamsMembers	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestrictedQueryParamsMembers[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

filter

public static final RestrictedQueryParamsMembers filter

Set of collection's fields used for filtering

sort

public static final RestrictedQueryParamsMembers sort

Set of collection's fields used for sorting

group

public static final RestrictedQueryParamsMembers group

Field to group by the collection

page

public static final RestrictedQueryParamsMembers page

Pagination properties

fields

public static final RestrictedQueryParamsMembers fields

List of specified fields to include in models

include

public static final RestrictedQueryParamsMembers include

Additional resources that should be attached to response

Method Detail

values

public static RestrictedQueryParamsMembers[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RestrictedQueryParamsMembers c : RestrictedQueryParamsMembers.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RestrictedQueryParamsMembers valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null