模块 wjybxx.btree.core

程序包 cn.wjybxx.btree.decorator

类 SubtreeRef<T>

java.lang.Object

cn.wjybxx.btree.Task<T>

cn.wjybxx.btree.Decorator<T>

cn.wjybxx.btree.decorator.SubtreeRef<T>

所有已实现的接口:

ICancelTokenListener

public class SubtreeRef<T>
extends Decorator<T>

子树引用

作者:

wjybxx date - 2023/11/26

字段概要

从类继承的字段 cn.wjybxx.btree.Decorator

child

从类继承的字段 cn.wjybxx.btree.Task

blackboard, cancelToken, flags, logger, MASK_AUTO_LISTEN_CANCEL, MASK_AUTO_RESET_CHILDREN, MASK_CONTROL_FLOW_FLAGS, MASK_DISABLE_AUTO_CHECK_CANCEL, MASK_DISABLE_DELAY_NOTIFY, MASK_SLOW_START, sharedProps

构造器概要

构造器

构造器	说明
SubtreeRef()
SubtreeRef(String subtreeName)

方法概要

修饰符和类型	方法	说明
protected void	enter(int reentryId)	该方法在Task进入运行状态时执行 1.数据初始化需要放在Task.beforeEnter()中，避免执行逻辑时对象未初始化完成。
protected void	execute()	Task的心跳方法，在Task进入完成状态之前会反复执行。
String	getSubtreeName()
protected void	onChildCompleted(Task<T> child)	子节点进入完成状态 1.避免方法数太多，实现类测试task的status即可 2.Task.getNormalizedStatus()有助于switch测试 3.task可能是取消状态，甚至可能没运行过直接失败（前置条件失败） 4.钩子任务和guard不会调用该方法 5.Task.isExecuting()有助于检测冲突，减少调用栈深度 6.同一子节点连续通知的情况下，completed的逻辑应当覆盖Task.onChildRunning(Task)的影响。
void	setSubtreeName(String subtreeName)

从类继承的方法 cn.wjybxx.btree.Decorator

addChildImpl, childStream, getChild, getChild, getChildCount, indexChild, onChildRunning, onEventImpl, removeChildImpl, setChild, setChildImpl, stopRunningChildren

从类继承的方法 cn.wjybxx.btree.Task

addChild, beforeEnter, canHandleEvent, checkCancel, exit, getBlackboard, getCancelToken, getControl, getControlData, getCurFrame, getEnterFrame, getEntity, getEntryBlackboard, getExitFrame, getFlags, getGuard, getNormalizedStatus, getPrevStatus, getReentryId, getRunFrames, getSharedProps, getStatus, getTaskEntry, isAutoCheckCancel, isAutoListenCancel, isAutoResetChildren, isCancelled, isCompleted, isDisableDelayNotify, isExecuteTriggeredByEnter, isExecuting, isExited, isExitTriggeredByStop, isFailed, isFailedOrCancelled, isLocked, isNotified, isReentered, isRunning, isSlowStart, isStillborn, isSucceeded, lock, onCancelRequested, onEvent, removeAllChild, removeChild, removeChild, resetChildrenForRestart, resetForRestart, resetForRestart, setAutoCheckCancel, setAutoListenCancel, setAutoResetChildren, setBlackboard, setCancelled, setCancelToken, setChild, setCompleted, setControl, setControlData, setDisableDelayNotify, setEnterFrame, setExitFrame, setFailed, setFlags, setGuard, setGuardFailed, setPrevStatus, setSharedProps, setSlowStart, setSuccess, stop, stop, template_checkGuard, template_execute, template_runChild, template_runChildDirectly, template_runHook, template_runHookDirectly, tryLock, unlock, unsetControl

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

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

构造器详细资料

SubtreeRef

public SubtreeRef()

SubtreeRef

public SubtreeRef(String subtreeName)

方法详细资料

enter

protected void enter(int reentryId)

从类复制的说明: Task

该方法在Task进入运行状态时执行 1.数据初始化需要放在Task.beforeEnter()中，避免执行逻辑时对象未初始化完成。 2.如果要初始化子节点，也放到Task.beforeEnter()方法; 3.允许更新自己为完成状态

覆盖:

enter 在类中 Task<T>

参数:

reentryId - 用于判断父类是否使任务进入了完成状态；虽然也可先捕获再调用超类方法，但传入会方便许多。

execute

protected void execute()

从类复制的说明: Task

Task的心跳方法，在Task进入完成状态之前会反复执行。 1.可以根据Task.isExecuteTriggeredByEnter()判断是否是与Task.enter(int)连续执行的。 2.运行中可通过Task.setSuccess()、Task.setFailed(int) ()}、Task.setCancelled()将自己更新为完成状态。 3.不建议直接调用该方法，而是通过模板方法运行。

指定者:

execute 在类中 Task<T>

onChildCompleted

protected void onChildCompleted(Task<T> child)

从类复制的说明: Task

子节点进入完成状态 1.避免方法数太多，实现类测试task的status即可 2.Task.getNormalizedStatus()有助于switch测试 3.task可能是取消状态，甚至可能没运行过直接失败（前置条件失败） 4.钩子任务和guard不会调用该方法 5.Task.isExecuting()有助于检测冲突，减少调用栈深度 6.同一子节点连续通知的情况下，completed的逻辑应当覆盖Task.onChildRunning(Task)的影响。 7.任何的回调和事件方法中都由用户自身检测取消信号

指定者:

onChildCompleted 在类中 Task<T>

getSubtreeName

public String getSubtreeName()

setSubtreeName

public void setSubtreeName(String subtreeName)