com.norconex.importer.filter
Enum OnMatch

java.lang.Object
  extended by java.lang.Enum<OnMatch>
      extended by com.norconex.importer.filter.OnMatch
All Implemented Interfaces:
Serializable, Comparable<OnMatch>

public enum OnMatch
extends Enum<OnMatch>

Constants indicating the action to perform upon matching a condition. Typically used with filtering conditions.

Author:
Pascal Essiembre

Enum Constant Summary
EXCLUDE
           
INCLUDE
           
 
Method Summary
static OnMatch valueOf(String name)
          Returns the enum constant of this type with the specified name.
static OnMatch[] 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

INCLUDE

public static final OnMatch INCLUDE

EXCLUDE

public static final OnMatch EXCLUDE
Method Detail

values

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

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

valueOf

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


Copyright © 2009-2013 Norconex Inc.. All Rights Reserved.