All Implemented Interfaces:

com.embabel.agent.core.AgentSystemStep , com.embabel.agent.core.Operation , com.embabel.common.core.types.Described , com.embabel.common.core.types.HasInfoString , com.embabel.common.core.types.Named , com.embabel.common.core.types.NamedAndDescribed , com.embabel.plan.Goal , com.embabel.plan.Step , com.embabel.plan.common.condition.ConditionGoal , com.embabel.plan.common.condition.ConditionStep
```
public final class Goal
 implements ConditionGoal, AgentSystemStep
                    
```
Agent platform goal. Exposes GOAP metadata.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Goal.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Map<String, ConditionDetermination>`	`preconditions`
`private final String`	`name`
`private final String`	`description`
`private final Set<String>`	`pre`
`private final Set<IoBinding>`	`inputs`
`private final DomainType`	`outputType`
`private final Function1<WorldState, Double>`	`value`
`private final Set<String>`	`tags`
`private final Set<String>`	`examples`
`private final Export`	`export`
`private final Set<String>`	`knownConditions`
`public final static Goal.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`Goal(String name, String description, Set<String> pre, Set<IoBinding> inputs, DomainType outputType, Function1<WorldState, Double> value, Set<String> tags, Set<String> examples, Export export)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Map<String, ConditionDetermination>`	`getPreconditions()`	Conditions that must be true for this step to execute
`String`	`getName()`
`String`	`getDescription()`
`final Set<String>`	`getPre()`
`Set<IoBinding>`	`getInputs()`
`final DomainType`	`getOutputType()`
`Function1<WorldState, Double>`	`getValue()`
`final Set<String>`	`getTags()`
`final Set<String>`	`getExamples()`
`final Export`	`getExport()`
`final Goal`	`withPreconditions(String preconditions)`
`final Goal`	`withGoalPreconditions(Goal goals)`
`final Goal`	`withFixedValue(Double value)`	Create a goal with the given value.
`String`	`infoString(Boolean verbose, Integer indent)`
`final static Goal`	`createInstance(String description, Class<?> type, String name, Set<String> tags, Set<String> examples)`	Convenient method to create a goal requiring creating an instance of this type.
`final static Goal`	`createInstance(String description, Class<?> type, String name, Set<String> tags)`	Convenient method to create a goal requiring creating an instance of this type.
`final static Goal`	`createInstance(String description, Class<?> type, String name)`	Convenient method to create a goal requiring creating an instance of this type.
`final static Goal`	`createInstance(String description, Class<?> type)`	Convenient method to create a goal requiring creating an instance of this type.

Methods inherited from class com.embabel.plan.common.condition.ConditionGoal
getKnownConditions
Methods inherited from class com.embabel.plan.common.condition.ConditionStep
isAchievable
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Goal
```
Goal(String name, String description, Set<String> pre, Set<IoBinding> inputs, DomainType outputType, Function1<WorldState, Double> value, Set<String> tags, Set<String> examples, Export export)
```
    Parameters:
    
    name - name of the goal
    
    description - description of the goal.
    
    pre - preconditions for the goal, as a set of strings.
    
    inputs - inputs required for the goal, as a set of IoBinding objects.
    
    outputType - if this goal returns a single instance of a domain type, this is the class that will be returned.
    
    value - value of the goal, as a ZeroToOne.
    
    tags - Set of tags describing classes or capabilities for this specific skill.
    
    examples - The set of example scenarios that the skill can perform.
- Method Detail
  - getPreconditions
```
 Map<String, ConditionDetermination> getPreconditions()
```
    Conditions that must be true for this step to execute
  - getName
```
 String getName()
```
  - getDescription
```
 String getDescription()
```
  - getPre
```
 final Set<String> getPre()
```
  - getInputs
```
 Set<IoBinding> getInputs()
```
  - getOutputType
```
 final DomainType getOutputType()
```
  - getValue
```
 Function1<WorldState, Double> getValue()
```
  - getTags
```
 final Set<String> getTags()
```
  - getExamples
```
 final Set<String> getExamples()
```
  - getExport
```
 final Export getExport()
```
  - withPreconditions
```
 final Goal withPreconditions(String preconditions)
```
  - withGoalPreconditions
```
 final Goal withGoalPreconditions(Goal goals)
```
  - withFixedValue
```
 final Goal withFixedValue(Double value)
```
    Create a goal with the given value.
  - infoString
```
 String infoString(Boolean verbose, Integer indent)
```
  - createInstance
```
@JvmOverloads() final static Goal createInstance(String description, Class<?> type, String name, Set<String> tags, Set<String> examples)
```
    Convenient method to create a goal requiring creating an instance of this type.
    
    Parameters:
    
    description - description of the goal
    
    type - type of the instance to create.
    
    name - name of the goal, defaults to "Create ${type.
  - createInstance
```
@JvmOverloads() final static Goal createInstance(String description, Class<?> type, String name, Set<String> tags)
```
    Convenient method to create a goal requiring creating an instance of this type.
    
    Parameters:
    
    description - description of the goal
    
    type - type of the instance to create.
    
    name - name of the goal, defaults to "Create ${type.
  - createInstance
```
@JvmOverloads() final static Goal createInstance(String description, Class<?> type, String name)
```
    Convenient method to create a goal requiring creating an instance of this type.
    
    Parameters:
    
    description - description of the goal
    
    type - type of the instance to create.
    
    name - name of the goal, defaults to "Create ${type.
  - createInstance
```
@JvmOverloads() final static Goal createInstance(String description, Class<?> type)
```
    Convenient method to create a goal requiring creating an instance of this type.
    
    Parameters:
    
    description - description of the goal
    
    type - type of the instance to create.

Class Goal

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.embabel.plan.common.condition.ConditionGoal

Methods inherited from class com.embabel.plan.common.condition.ConditionStep

Methods inherited from class java.lang.Object

Constructor Detail

Goal

Method Detail

getPreconditions

getName

getDescription

getPre

getInputs

getOutputType

getValue

getTags

getExamples

getExport

withPreconditions

withGoalPreconditions

withFixedValue

infoString

createInstance

createInstance

createInstance

createInstance