模块 wjybxx.commons.base
程序包 cn.wjybxx.base.concurrent

类 CancelCodes

java.lang.Object
cn.wjybxx.base.concurrent.CancelCodes
public class CancelCodes extends Object
取消码辅助类
作者:
wjybxx date - 2024/4/11

  • 字段概要

    字段
    修饰符和类型
    字段
    说明
    static final int
    MASK_DEGREE
    紧迫程度的掩码（4it）-- 0表示未指定
    static final int
    MASK_FROM_FUTURE
    表示取消信号来自Future的取消接口
    static final int
    MASK_INTERRUPT
    中断的掩码 （1bit）
    static final int
    MASK_REASON
    原因的掩码 1.如果cancelCode不包含其它信息，就等于reason 2.设定为20位，可达到100W
    static final int
    MASK_REVERSED
    预留4bit
    static final int
    MASK_WITHOUT_REMOVE
    告知任务无需执行删除逻辑 -- 慎用
    static final int
    MAX_DEGREE
    最大紧急程度
    static final int
    MAX_REASON
    最大取消原因
    static final int
    OFFSET_DEGREE
    紧急度的偏移量
    static final int
    OFFSET_REASON
    取消原因的偏移量
    static final int
    REASON_DEFAULT
    默认原因
    static final int
    REASON_SHUTDOWN
    Executor关闭 -- Executor关闭不一定会取消任务
    static final int
    REASON_TIMEOUT
    执行超时

  • 方法概要

    修饰符和类型
    方法
    说明
    static int
    checkCode(int code)
    检查取消码的合法性
    static int
    getDegree(int code)
    计算取消码终归的紧急程度
    static int
    getReason(int code)
    计算取消码中的原因
    static boolean
    isCancelling(int code)
    取消码是否表示已收到取消信号
    static boolean
    isFromFuture(int code)
    取消信号是否来自future接口
    static boolean
    isInterruptible(int code)
    取消指令中是否要求了中断线程
    static boolean
    isWithoutRemove(int code)
    取消指令中是否要求了无需删除
    static int
    setDegree(int code, int value)
    设置紧急程度
    static int
    setInterruptible(int code, boolean value)
    设置中断标记
    static int
    setReason(int code, int value)
    设置取消原因
    static int
    setWithoutRemove(int code, boolean value)
    设置是否不立即删除

    从类继承的方法 java.lang.Object

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

  • 字段详细资料

    • MASK_REASON

      public static final int MASK_REASON
      原因的掩码 1.如果cancelCode不包含其它信息，就等于reason 2.设定为20位，可达到100W
      另请参阅:

    • MASK_DEGREE

      public static final int MASK_DEGREE
      紧迫程度的掩码（4it）-- 0表示未指定
      另请参阅:

    • MASK_REVERSED

      public static final int MASK_REVERSED
      预留4bit
      另请参阅:

    • MASK_INTERRUPT

      public static final int MASK_INTERRUPT
      中断的掩码 （1bit）
      另请参阅:

    • MASK_WITHOUT_REMOVE

      public static final int MASK_WITHOUT_REMOVE
      告知任务无需执行删除逻辑 -- 慎用
      另请参阅:

    • MASK_FROM_FUTURE

      public static final int MASK_FROM_FUTURE
      表示取消信号来自Future的取消接口
      另请参阅:

    • MAX_REASON

      public static final int MAX_REASON
      最大取消原因
      另请参阅:

    • MAX_DEGREE

      public static final int MAX_DEGREE
      最大紧急程度
      另请参阅:

    • OFFSET_REASON

      public static final int OFFSET_REASON
      取消原因的偏移量
      另请参阅:

    • OFFSET_DEGREE

      public static final int OFFSET_DEGREE
      紧急度的偏移量
      另请参阅:

    • REASON_DEFAULT

      public static final int REASON_DEFAULT
      默认原因
      另请参阅:

    • REASON_TIMEOUT

      public static final int REASON_TIMEOUT
      执行超时
      另请参阅:

    • REASON_SHUTDOWN

      public static final int REASON_SHUTDOWN
      Executor关闭 -- Executor关闭不一定会取消任务
      另请参阅:

  • 方法详细资料

    • isCancelling

      public static boolean isCancelling(int code)
      取消码是否表示已收到取消信号

    • getReason

      public static int getReason(int code)
      计算取消码中的原因

    • getDegree

      public static int getDegree(int code)
      计算取消码终归的紧急程度

    • isInterruptible

      public static boolean isInterruptible(int code)
      取消指令中是否要求了中断线程

    • isWithoutRemove

      public static boolean isWithoutRemove(int code)
      取消指令中是否要求了无需删除

    • isFromFuture

      public static boolean isFromFuture(int code)
      取消信号是否来自future接口

    • setDegree

      public static int setDegree(int code, int value)
      设置紧急程度

    • setReason

      public static int setReason(int code, int value)
      设置取消原因

    • setInterruptible

      public static int setInterruptible(int code, boolean value)
      设置中断标记

    • setWithoutRemove

      public static int setWithoutRemove(int code, boolean value)
      设置是否不立即删除

    • checkCode

      public static int checkCode(int code)
      检查取消码的合法性
      返回:
      argument