Enum SqlCmpOptions

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SqlCmpOptions>

    public enum SqlCmpOptions
    extends java.lang.Enum<SqlCmpOptions>
    Specifies the SQL compare options.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BinarySort
      Specifies that sorts should be based on a characters numeric value instead of its alphabetical value
      BinarySort2
      Performs a binary sort
      IgnoreCase
      Specifies that SqlString comparisons must ignore case.
      IgnoreKanaType
      Specifies that System.Data.SqlTypes.SqlString comparisons must ignore the Kana type.
      IgnoreNonSpace
      Specifies that SqlString comparisons must ignore nonspace combining characters, such as diacritics.
      IgnoreWidth
      Specifies that System.Data.SqlTypes.SqlString comparisons must ignore the character width.
      None
      Specifies the default option settings for SqlString comparisons.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SqlCmpOptions getSqlCmpOptions​(int value)
      retreives the enum constant of the specified value, if exists.
      static SqlCmpOptions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SqlCmpOptions[] 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

      • None

        public static final SqlCmpOptions None
        Specifies the default option settings for SqlString comparisons.
      • IgnoreCase

        public static final SqlCmpOptions IgnoreCase
        Specifies that SqlString comparisons must ignore case.
      • IgnoreNonSpace

        public static final SqlCmpOptions IgnoreNonSpace
        Specifies that SqlString comparisons must ignore nonspace combining characters, such as diacritics. The Unicode Standard defines combining characters as characters that are combined with base characters to produce a new character. Non-space combining characters do not use character space by themselves when rendered. For more information about non-space combining characters, see the Unicode Standard at http://www.unicode.org.
      • IgnoreKanaType

        public static final SqlCmpOptions IgnoreKanaType
        Specifies that System.Data.SqlTypes.SqlString comparisons must ignore the Kana type. Kana type refers to Japanese hiragana and katakana characters that represent phonetic sounds in the Japanese language. Hiragana is used for native Japanese expressions and words, while katakana is used for words borrowed from other languages, such as "computer" or "Internet". A phonetic sound can be expressed in both hiragana and katakana. If this value is selected, the hiragana character for one sound is considered equal to the katakana character for the same sound.
      • IgnoreWidth

        public static final SqlCmpOptions IgnoreWidth
        Specifies that System.Data.SqlTypes.SqlString comparisons must ignore the character width. For example, Japanese katakana characters can be written as full-width or half-width and, if this value is selected, the katakana characters written as full-width are considered equal to the same characters written in half-width.
      • BinarySort2

        public static final SqlCmpOptions BinarySort2
        Performs a binary sort
      • BinarySort

        public static final SqlCmpOptions BinarySort
        Specifies that sorts should be based on a characters numeric value instead of its alphabetical value
    • Method Detail

      • values

        public static SqlCmpOptions[] 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 (SqlCmpOptions c : SqlCmpOptions.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SqlCmpOptions 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
      • getSqlCmpOptions

        public static SqlCmpOptions getSqlCmpOptions​(int value)
                                              throws java.lang.IllegalArgumentException
        retreives the enum constant of the specified value, if exists.
        Parameters:
        value - enum constant index
        Returns:
        enum constant
        Throws:
        java.lang.IllegalArgumentException