Package org.elasticsearch.common

Class Booleans

  • public final class Booleans
extends java.lang.Object

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean isBoolean​(char[] text, int offset, int length)
      returns true iff the sequence of chars is one of "true","false".
      static boolean isBoolean​(java.lang.String value)  
      static boolean isBooleanLenient​(char[] text, int offset, int length)
      Deprecated.
      Only kept to provide automatic upgrades for pre 6.0 indices.
      static boolean isFalse​(java.lang.String value)  
      static boolean isTrue​(java.lang.String value)  
      static boolean parseBoolean​(char[] text, int offset, int length, boolean defaultValue)
      Parses a char[] representation of a boolean value to boolean.
      static boolean parseBoolean​(java.lang.String value)
      Parses a string representation of a boolean value to boolean.
      static boolean parseBoolean​(java.lang.String value, boolean defaultValue)  
      static java.lang.Boolean parseBoolean​(java.lang.String value, java.lang.Boolean defaultValue)  
      static boolean parseBooleanLenient​(char[] text, int offset, int length, boolean defaultValue)
      Deprecated.
      Only kept to provide automatic upgrades for pre 6.0 indices.
      static boolean parseBooleanLenient​(java.lang.String value, boolean defaultValue)
      Deprecated.
      Only kept to provide automatic upgrades for pre 6.0 indices.
      static java.lang.Boolean parseBooleanLenient​(java.lang.String value, java.lang.Boolean defaultValue)
      Deprecated.
      Only kept to provide automatic upgrades for pre 6.0 indices.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • parseBoolean

        public static boolean parseBoolean​(char[] text,
                                   int offset,
                                   int length,
                                   boolean defaultValue)
        Parses a char[] representation of a boolean value to boolean.
        Returns:
        true iff the sequence of chars is "true", false iff the sequence of chars is "false" or the provided default value iff either text is null or length == 0.
        Throws:
        java.lang.IllegalArgumentException - if the string cannot be parsed to boolean.

      • isBoolean

        public static boolean isBoolean​(char[] text,
                                int offset,
                                int length)
        returns true iff the sequence of chars is one of "true","false".
        Parameters:
        text - sequence to check
        offset - offset to start
        length - length to check

      • isBoolean

        public static boolean isBoolean​(java.lang.String value)

      • parseBoolean

        public static boolean parseBoolean​(java.lang.String value)
        Parses a string representation of a boolean value to boolean.
        Returns:
        true iff the provided value is "true". false iff the provided value is "false".
        Throws:
        java.lang.IllegalArgumentException - if the string cannot be parsed to boolean.

      • parseBoolean

        public static boolean parseBoolean​(java.lang.String value,
                                   boolean defaultValue)
        Parameters:
        value - text to parse.
        defaultValue - The default value to return if the provided value is null.
        Returns:
        see parseBoolean(String)

      • parseBoolean

        public static java.lang.Boolean parseBoolean​(java.lang.String value,
                                             java.lang.Boolean defaultValue)

      • parseBooleanLenient

        @Deprecated
public static java.lang.Boolean parseBooleanLenient​(java.lang.String value,
                                                    java.lang.Boolean defaultValue)
        Deprecated.
        Only kept to provide automatic upgrades for pre 6.0 indices. Use parseBoolean(String, Boolean) instead.
        Returns false if text is in "false", "0", "off", "no"; else, true.

      • parseBooleanLenient

        @Deprecated
public static boolean parseBooleanLenient​(java.lang.String value,
                                          boolean defaultValue)
        Deprecated.
        Only kept to provide automatic upgrades for pre 6.0 indices. Use parseBoolean(String, boolean) instead.
        Returns false if text is in "false", "0", "off", "no"; else, true.

      • isFalse

        public static boolean isFalse​(java.lang.String value)
        Returns:
        true iff the value is "false", otherwise false.

      • isTrue

        public static boolean isTrue​(java.lang.String value)
        Returns:
        true iff the value is "true", otherwise false.

      • parseBooleanLenient

        @Deprecated
public static boolean parseBooleanLenient​(char[] text,
                                          int offset,
                                          int length,
                                          boolean defaultValue)
        Deprecated.
        Only kept to provide automatic upgrades for pre 6.0 indices. Use parseBoolean(char[], int, int, boolean) instead
        Returns false if text is in "false", "0", "off", "no"; else, true.

      • isBooleanLenient

        @Deprecated
public static boolean isBooleanLenient​(char[] text,
                                       int offset,
                                       int length)
        Deprecated.
        Only kept to provide automatic upgrades for pre 6.0 indices. Use isBoolean(char[], int, int) instead.
        returns true if the a sequence of chars is one of "true","false","on","off","yes","no","0","1"
        Parameters:
        text - sequence to check
        offset - offset to start
        length - length to check