Module agentforge4j.config.loader

Package com.agentforge4j.config.loader.workflow

Record Class WorkflowBundleLoadContext

java.lang.Object

java.lang.Record

com.agentforge4j.config.loader.workflow.WorkflowBundleLoadContext

public record WorkflowBundleLoadContext(Optional<Path> workflowRoot)
extends Record

Immutable context for a single workflow bundle loading invocation.

Constructor Summary

Constructors

Constructor	Description
WorkflowBundleLoadContext(Optional<Path> workflowRoot)	Creates an instance of a WorkflowBundleLoadContext record class.

Method Summary

Modifier and Type	Method	Description
static WorkflowBundleLoadContext	classpath()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static WorkflowBundleLoadContext	filesystem(Path root)
final int	hashCode()	Returns a hash code value for this object.
Path	requireWorkflowRoot()	Returns the filesystem workflow root.
final String	toString()	Returns a string representation of this record class.
Optional<Path>	workflowRoot()	Returns the value of the workflowRoot record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WorkflowBundleLoadContext

public WorkflowBundleLoadContext(Optional<Path> workflowRoot)

Creates an instance of a WorkflowBundleLoadContext record class.

Parameters:

workflowRoot - the value for the workflowRoot record component

Method Details

classpath

public static WorkflowBundleLoadContext classpath()

filesystem

public static WorkflowBundleLoadContext filesystem(Path root)

requireWorkflowRoot

public Path requireWorkflowRoot()

Returns the filesystem workflow root.

Returns:

the workflow root

Throws:

IllegalStateException - when this context has no workflow root (a classpath context)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

workflowRoot

public Optional<Path> workflowRoot()

Returns the value of the workflowRoot record component.

Returns:

the value of the workflowRoot record component