Module  java.base
软件包  java.util

Class OptionalInt



  • public final class OptionalInt
    extends Object
    可能包含或可能不包含int值的容器对象。 如果存在值,则isPresent()返回true ,返回值为getAsInt()

    提供依赖于存在或不存在包含值的附加方法,例如orElse() (如果没有值,则返回默认值)和ifPresent() (如果值存在则执行操作)。

    这是一个value-based类; 对于OptionalInt实例,使用身份敏感操作(包括参考相等性( == ),身份哈希码或同步)可能会产生不可预测的结果,应该避免。

    API Note:
    OptionalInt主要用作方法返回类型,其中明确需要表示“无结果”。 类型为OptionalInt变量本身不应为null ; 它应该总是指向一个OptionalInt实例。
    从以下版本开始:
    1.8
    • 方法摘要

      所有方法  静态方法  接口方法  具体的方法 
      Modifier and Type 方法 描述
      static OptionalInt empty​()
      返回一个空的 OptionalInt实例。
      boolean equals​(Object obj)
      指示某个其他对象是否等于此 OptionalInt
      int getAsInt​()
      如果值存在,则返回值,否则抛出 NoSuchElementException
      int hashCode​()
      返回值的哈希码,如果存在,否则为 0 (零),如果没有值。
      void ifPresent​(IntConsumer action)
      如果存在值,则使用该值执行给定的操作,否则不执行任何操作。
      void ifPresentOrElse​(IntConsumer action, Runnable emptyAction)
      如果存在值,则使用该值执行给定的操作,否则执行给定的基于空的操作。
      boolean isPresent​()
      如果存在值,则返回 true ,否则为 false
      static OptionalInt of​(int value)
      返回描述给定值的 OptionalInt
      int orElse​(int other)
      如果存在值,则返回值,否则返回 other
      int orElseGet​(IntSupplier supplier)
      如果存在值,则返回值,否则返回由供应函数产生的结果。
      <X extends Throwable>
      int
      orElseThrow​(Supplier<? extends X> exceptionSupplier)
      如果存在值,则返回值,否则将抛出由异常提供函数产生的异常。
      IntStream stream​()
      如果存在值,则返回仅包含该值的序列IntStream ,否则返回一个空的IntStream
      String toString​()
      返回适用于调试的 OptionalInt的非空字符串表示形式。
    • 方法详细信息

      • empty

        public static OptionalInt empty​()
        返回一个空的OptionalInt实例。 这个OptionalInt没有值。
        API Note:
        虽然它可能是很有诱惑力的话,避免测试如果一个对象是通过比较空==对抗返回实例OptionalInt.empty() 不能保证是单身人士。 相反,请使用isPresent()
        结果
        一个空的 OptionalInt
      • of

        public static OptionalInt of​(int value)
        返回描述给定值的 OptionalInt
        参数
        value - 要描述的值
        结果
        一个 OptionalInt与值存在
      • getAsInt

        public int getAsInt​()
        如果存在值,返回值,否则抛出 NoSuchElementException
        API Note:
        方法 orElseorElseGet通常优于该方法,因为如果该值不存在则返回替代值,而不是抛出异常。
        结果
        该值由此描述 OptionalInt
        异常
        NoSuchElementException - 如果没有值
        另请参见:
        isPresent()
      • isPresent

        public boolean isPresent​()
        如果存在值,则返回 true ,否则为 false
        结果
        true如果一个值存在,否则 false
      • ifPresent

        public void ifPresent​(IntConsumer action)
        如果存在值,则使用该值执行给定的操作,否则不执行任何操作。
        参数
        action - 要执行的操作,如果值存在
        异常
        NullPointerException - 如果存在值且给定的操作是 null
      • ifPresentOrElse

        public void ifPresentOrElse​(IntConsumer action,
                                    Runnable emptyAction)
        如果存在值,则使用该值执行给定的操作,否则执行给定的基于空的操作。
        参数
        action - 要执行的操作,如果值存在
        emptyAction - 要执行的基于空的操作,如果没有值
        异常
        NullPointerException - 如果存在值且给定的操作是 null ,或者不存在任何值,并且给定的基于空的操作是 null
        从以下版本开始:
        9
      • stream

        public IntStream stream​()
        如果存在值,则返回仅包含该值的序列IntStream ,否则返回空IntStream
        API Note:
        此方法可用于将Stream的可选整数IntStream为当前整数的IntStream
           Stream<OptionalInt> os = .. IntStream s = os.flatMapToInt(OptionalInt::stream)  
        结果
        可选值为 IntStream
        从以下版本开始:
        9
      • orElse

        public int orElse​(int other)
        如果存在值,则返回值,否则返回 other
        参数
        other - 如果没有值,则返回的值
        结果
        该值,如果存在,否则为 other
      • orElseGet

        public int orElseGet​(IntSupplier supplier)
        如果存在值,则返回值,否则返回由供应函数产生的结果。
        参数
        supplier - 产生要返回的值的供应函数
        结果
        该值(如果存在),否则由供应功能产生的结果
        异常
        NullPointerException - 如果没有值,并且提供功能是 null
      • orElseThrow

        public <X extends Throwable> int orElseThrow​(Supplier<? extends X> exceptionSupplier)
                                              throws X extends Throwable
        如果存在值,则返回值,否则将抛出由异常提供函数产生的异常。
        API Note:
        可以使用具有空参数列表的异常构造函数的方法引用作为供应商。 例如, IllegalStateException::new
        参数类型
        X - 要抛出的异常的类型
        参数
        exceptionSupplier - 产生要抛出的异常的供应函数
        结果
        价值,如果存在
        异常
        X - 如果没有值
        NullPointerException - 如果没有值,异常提供功能是 null
        X extends Throwable
      • equals

        public boolean equals​(Object obj)
        指示某个其他对象是否等于此OptionalInt 另一个对象被认为是相等的:
        • 它也是一个OptionalInt和;
        • 或者;
        • 当前值通过==彼此“相等”。
        重写:
        equalsObject
        参数
        obj - 要进行相等测试的对象
        结果
        true如果另一个对象是“等于”这个对象否则 false
        另请参见:
        Object.hashCode()HashMap
      • toString

        public String toString​()
        返回适用于调试的OptionalInt的非空字符串表示形式。 准确的表示格式是未指定的,可能会在实现和版本之间变化。
        重写:
        toStringObject
        实现要求:
        如果存在值,则结果必须在其结果中包含其字符串表示形式。 空和现在OptionalInt必须明确区分。
        结果
        该实例的字符串表示形式