com.helger.commons.filter

Enum EFilterMatchingStrategy

java.lang.Object

java.lang.Enum<EFilterMatchingStrategy>

com.helger.commons.filter.EFilterMatchingStrategy

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EFilterMatchingStrategy>

public enum EFilterMatchingStrategy
extends Enum<EFilterMatchingStrategy>
implements IHasID<String>

Filter matching strategy for IFilter implementations based on AbstractFilter.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
MATCH_ALL Math both this filter and an eventually present nested filter.
MATCH_ANY Match either this filter or an eventually present nested filter.

Method Summary

Modifier and Type	Method and Description
static EFilterMatchingStrategy	getFromIDOrNull(String sID)
String	getID() Get the unique ID of this object.
static EFilterMatchingStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static EFilterMatchingStrategy[]	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

MATCH_ANY

public static final EFilterMatchingStrategy MATCH_ANY

Match either this filter or an eventually present nested filter. If no nested filter is present, only this filter must match.

MATCH_ALL

public static final EFilterMatchingStrategy MATCH_ALL

Math both this filter and an eventually present nested filter. If no nested filter is present, only this filter must match.

Method Detail

values

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

Returns:

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

valueOf

public static EFilterMatchingStrategy 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

getID

@Nonnull
 @Nonempty
public String getID()

Description copied from interface: IHasID

Get the unique ID of this object. If the type is String than the returned value must match an XML NMToken expression (so e.g. no ':' in the ID)!

Specified by:

getID in interface IHasID<String>

Returns:

The ID of this object. May not be null.

getFromIDOrNull

@Nullable
public static EFilterMatchingStrategy getFromIDOrNull(@Nullable
                                                                 String sID)