Project: stp

com.ibm.rational.wvcm.stp.cq
Enum CqUserDb.WordMode

Object
  extended by Enum<CqUserDb.WordMode>
      extended by CqUserDb.WordMode
All Implemented Interfaces:
CqUserDb.SearchKey<List<String>>, Serializable, Comparable<CqUserDb.WordMode>
Enclosing interface:
CqUserDb

public static enum CqUserDb.WordMode
extends Enum<CqUserDb.WordMode>
implements CqUserDb.SearchKey<List<String>>

WordMode SearchKeys limit the search results to just those objects that contain the targeted words associated with the WordMode key in the filter.


Enum Constant Summary
ALL
          Match all of the words in the target list
ANY
          Match any (at least one) of the words in the target list
EXACT
          Match all of the words in the target list in the order given
NONE
          Match none (do not match any) of the words in the target list
 
Method Summary
static CqUserDb.WordMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqUserDb.WordMode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ALL

public static final CqUserDb.WordMode ALL
Match all of the words in the target list


ANY

public static final CqUserDb.WordMode ANY
Match any (at least one) of the words in the target list


EXACT

public static final CqUserDb.WordMode EXACT
Match all of the words in the target list in the order given


NONE

public static final CqUserDb.WordMode NONE
Match none (do not match any) of the words in the target list

Method Detail

valueOf

public static CqUserDb.WordMode 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

values

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

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

Generated Wed 14-Mar-2018 10:38 PM

Copyright © IBM 2018. All rights reserved.