com.smartfoxserver.v2.entities.match

Enum StringMatch

java.lang.Object

java.lang.Enum<StringMatch>

com.smartfoxserver.v2.entities.match.StringMatch

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StringMatch>

public enum StringMatch
extends java.lang.Enum<StringMatch>

This matcher is used in MatchExpressions to check String conditions

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINS Check that Str1.indexOf(Str2) > -1
ENDS_WITH Check that Str1.endsWith(Str2)
EQUALS Check that Str1.equals(Str2)
NOT_EQUALS Check that !
STARTS_WITH Check that Str1.startsWith(Str2)

Method Summary

Modifier and Type	Method and Description
static StringMatch	fromSymbol(java.lang.String symbol)
java.lang.String	getSymbol() Return the symbol that identifies the matchers
int	getType()
static StringMatch	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StringMatch[]	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

EQUALS

public static final StringMatch EQUALS

Check that Str1.equals(Str2)

NOT_EQUALS

public static final StringMatch NOT_EQUALS

Check that !Str1.equals(Str2)

CONTAINS

public static final StringMatch CONTAINS

Check that Str1.indexOf(Str2) > -1

STARTS_WITH

public static final StringMatch STARTS_WITH

Check that Str1.startsWith(Str2)

ENDS_WITH

public static final StringMatch ENDS_WITH

Check that Str1.endsWith(Str2)

Method Detail

values

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

Returns:

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

valueOf

public static StringMatch valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getSymbol

public java.lang.String getSymbol()

Return the symbol that identifies the matchers

Returns:

the symbol that identifies the matchers

getType

public int getType()

fromSymbol

public static StringMatch fromSymbol(java.lang.String symbol)