Package org.ametys.web.filter

Enum WebContentFilter.Context

java.lang.Object

java.lang.Enum<WebContentFilter.Context>

org.ametys.web.filter.WebContentFilter.Context

All Implemented Interfaces:

Serializable, Comparable<WebContentFilter.Context>

Enclosing interface:

WebContentFilter

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

The search context

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHILD_PAGES	Constant to search in child pages
CURRENT_SITE	Constant to search only on current site
NO_SITE	Constant to search outside a site
OTHER_SITES	Constant to search in other sites
SITES	Constant to search in all sites
SITES_LIST	Constant to search in all sites

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Context()

Method Summary

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

Constant to search only on current site

SITES_LIST

public static final WebContentFilter.Context SITES_LIST

Constant to search in all sites

SITES

public static final WebContentFilter.Context SITES

Constant to search in all sites

OTHER_SITES

public static final WebContentFilter.Context OTHER_SITES

Constant to search in other sites

CHILD_PAGES

public static final WebContentFilter.Context CHILD_PAGES

Constant to search in child pages

NO_SITE

public static final WebContentFilter.Context NO_SITE

Constant to search outside a site

Constructor Detail

Context

private Context()

Method Detail

values

public static WebContentFilter.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 (WebContentFilter.Context c : WebContentFilter.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 WebContentFilter.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