BranchTask (epicbot-api 1.0 API)

java.lang.Object
- com.epicbot.api.shared.script.tree.BranchTask

All Implemented Interfaces:: TreeTask

public abstract class BranchTask
extends java.lang.Object
implements TreeTask

Field Summary

Fields
Modifier and Type Field Description

protected APIContext ctx

Constructor Summary

Constructors
Constructor Description

BranchTask(APIContext ctx)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract TreeTask`	`createFailureTask(APIContext ctx)`	The failure task that will be executed when `validate()` is false.
`protected abstract TreeTask`	`createSuccessTask(APIContext ctx)`	The success task that will be executed when `validate()` is true.
`void`	`execute()`	Execute this task.
`abstract boolean`	`validate()`	Returns the condition of this branch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ctx
```
protected APIContext ctx
```
- Constructor Detail
  - BranchTask
```
public BranchTask(APIContext ctx)
```
- Method Detail
  - createSuccessTask
```
protected abstract TreeTask createSuccessTask(APIContext ctx)
```
    The success task that will be executed when validate() is true.
    
    Parameters:
    
    ctx - APIContext
    
    Returns:
    
    the success task
  - createFailureTask
```
protected abstract TreeTask createFailureTask(APIContext ctx)
```
    The failure task that will be executed when validate() is false.
    
    Parameters:
    
    ctx - APIContext
    
    Returns:
    
    the failure task
  - validate
```
public abstract boolean validate()
```
    Returns the condition of this branch.
    
    Returns:
    
    boolean
  - execute
```
public final void execute()
```
    Description copied from interface: TreeTask
    
    Execute this task.
    
    Specified by:
    
    execute in interface TreeTask