org.ametys.web.filter

Enum PageFilter.Context

java.lang.Object

java.lang.Enum<PageFilter.Context>

org.ametys.web.filter.PageFilter.Context

All Implemented Interfaces:

Serializable, Comparable<PageFilter.Context>

Enclosing interface:

PageFilter

public static enum PageFilter.Context
extends Enum<PageFilter.Context>

The search context

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILD_PAGES Constant to search in child pages
CURRENT_SITE Constant to search only on current site
OTHER_SITES Constant to search in other sites
SITES Constant to search in all sites

Method Summary

Modifier and Type	Method and Description
static PageFilter.Context	valueOf(String name) Returns the enum constant of this type with the specified name.
static PageFilter.Context[]	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

CURRENT_SITE

public static final PageFilter.Context CURRENT_SITE

Constant to search only on current site

SITES

public static final PageFilter.Context SITES

Constant to search in all sites

OTHER_SITES

public static final PageFilter.Context OTHER_SITES

Constant to search in other sites

CHILD_PAGES

public static final PageFilter.Context CHILD_PAGES

Constant to search in child pages

Method Detail

values

public static PageFilter.Context[] 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 (PageFilter.Context c : PageFilter.Context.values())
    System.out.println(c);

Returns:

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

valueOf

public static PageFilter.Context 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