Package sfs2x.client.entities.match

Enum StringMatch

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StringMatch>, IMatcher
    public enum StringMatch
extends java.lang.Enum<StringMatch>
implements IMatcher
    The StringMatch class is used in matching expressions to check string conditions.
    See Also:
    MatchExpression

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CONTAINS
      An instance of StringMatch representing the following condition: string1.indexOf(string2) !
      ENDS_WITH
      An instance of StringMatch representing the following condition: string1 ends with characters contained in string2.
      EQUALS
      An instance of StringMatch representing the following condition: string1 == string2.
      NOT_EQUALS
      An instance of StringMatch representing the following condition: string1 !
      STARTS_WITH
      An instance of StringMatch representing the following condition: string1 starts with characters contained in string2.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getSymbol()
      Returns the condition symbol of this matcher.
      int getType()
      Returns the type id of this matcher.
      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

        compareTo, equals, 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
        An instance of StringMatch representing the following condition: string1 == string2.

      • NOT_EQUALS

        public static final StringMatch NOT_EQUALS
        An instance of StringMatch representing the following condition: string1 != string2.

      • CONTAINS

        public static final StringMatch CONTAINS
        An instance of StringMatch representing the following condition: string1.indexOf(string2) != -1.

      • STARTS_WITH

        public static final StringMatch STARTS_WITH
        An instance of StringMatch representing the following condition: string1 starts with characters contained in string2.

      • ENDS_WITH

        public static final StringMatch ENDS_WITH
        An instance of StringMatch representing the following condition: string1 ends with characters contained in string2.

    • 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()
        Description copied from interface: IMatcher
        Returns the condition symbol of this matcher.
        Specified by:
        getSymbol in interface IMatcher

      • getType

        public int getType()
        Description copied from interface: IMatcher
        Returns the type id of this matcher.
        Specified by:
        getType in interface IMatcher