GroovyshOptions (Groovy 6.0.0-RC-3)

org.apache.groovy.groovysh.GroovyshOptions

```
@Incubating
public final class GroovyshOptions
extends Object
```
Configuration for embedding groovysh programmatically via Main.start.
Where a setting has an equivalent on JLine's org.jline.shell.ShellBuilder, this class deliberately uses the same name and parameter type, so that a future move of groovysh onto org.jline.shell is re-plumbing rather than a break in Groovy's API. The Groovy-specific settings — compiler configuration, engine, bindings, banner, and the result/error handlers a language REPL needs and a command shell does not — have no such equivalent.
Binding variables stay in getBindings(); they are not mixed with embedding hooks. Construct with builder().
Since:
7.0.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`GroovyshOptions.Builder`	Builder for GroovyshOptions.
`interface`	`GroovyshOptions.ErrorHandler`	Handles an error thrown by the REPL loop.
`interface`	`GroovyshOptions.ResultHandler`	Handles a value produced by the REPL loop.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static GroovyshOptions.Builder`	`builder()` Creates a builder for embedding options.
	`public Map<String, Object>`	`getBindings()` Binding variables installed on the engine before the REPL starts.
	`public CompilerConfiguration`	`getCompilerConfiguration()` Compiler configuration used when this object does not already hold an engine.
	`public GroovyEngine`	`getEngine()` Pre-built engine.
	`public GroovyshOptions.ErrorHandler`	`getErrorHandler()` Error renderer.
	`public List<org.jline.shell.CommandGroup>`	`getGroups()` Command groups contributed by the embedder.
	`public Path`	`getHistoryFile()` History file for the session.
	`public BiConsumer<org.jline.reader.LineReader, GroovySystemRegistry>`	`getOnReaderReady()` Callback invoked once the reader and the command registry are both wired, immediately before the REPL starts, for settings this class does not model — the secondary prompt pattern, key bindings, reader options, and the completer.
	`public Supplier<String>`	`getPrompt()` Prompt supplier invoked on each REPL iteration.
	`public GroovyshOptions.ResultHandler`	`getResultHandler()` Result renderer.
	`public Supplier<String>`	`getRightPrompt()` Right-hand prompt supplier invoked on each REPL iteration.
	`public Terminal`	`getTerminal()` Terminal to use instead of the one Main would build from CLI flags.
	`public boolean`	`isShowBanner()` Whether Main should print the groovysh banner (or the quiet version line).

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Method Detail
  - public static GroovyshOptions.Builder builder()
    
    Creates a builder for embedding options.
    Returns:
    a new builder with default values
  - public Map<String, Object> getBindings()
    
    Binding variables installed on the engine before the REPL starts.
    Returns:
    an unmodifiable map, never null
  - public CompilerConfiguration getCompilerConfiguration()
    
    Compiler configuration used when this object does not already hold an engine. null means CompilerConfiguration.DEFAULT.
    Returns:
    the compiler configuration, or null
  - public GroovyEngine getEngine()
    
    Pre-built engine. When non-null, getCompilerConfiguration() is ignored because the engine already carries its configuration.
    Returns:
    the engine, or null to let Main construct one
  - public GroovyshOptions.ErrorHandler getErrorHandler()
    
    Error renderer. null means groovysh's own trace.
    Returns:
    the error handler, or null
  - public List<org.jline.shell.CommandGroup> getGroups()
    
    Command groups contributed by the embedder. They are resolved before groovysh's own commands, so a group may override a built-in command name.
    Returns:
    an unmodifiable list, never null
  - public Path getHistoryFile()
    
    History file for the session. null means groovysh's own groovysh_history in the user state directory.
    Returns:
    the history file, or null
  - public BiConsumer<org.jline.reader.LineReader, GroovySystemRegistry> getOnReaderReady()
    
    Callback invoked once the reader and the command registry are both wired, immediately before the REPL starts, for settings this class does not model — the secondary prompt pattern, key bindings, reader options, and the completer.
    Returns:
    the callback, or null
  - public Supplier<String> getPrompt()
    
    Prompt supplier invoked on each REPL iteration. null means "groovy> ".
    Returns:
    the prompt supplier, or null
  - public GroovyshOptions.ResultHandler getResultHandler()
    
    Result renderer. null means print result?.toString() via the printer.
    Returns:
    the result handler, or null
  - public Supplier<String> getRightPrompt()
    
    Right-hand prompt supplier invoked on each REPL iteration.
    Returns:
    the right prompt supplier, or null for none
  - public Terminal getTerminal()
    
    Terminal to use instead of the one Main would build from CLI flags.
    Returns:
    the terminal, or null to build the default
  - public boolean isShowBanner()
    
    Whether Main should print the groovysh banner (or the quiet version line).
    Returns:
    true to print the banner

Summary:
Nested
Method

| Detail:
Method

[Java] Class GroovyshOptions

Nested Class Summary

Methods Summary

Inherited Methods Summary

Method Detail

public static GroovyshOptions.Builder builder()

public Map<String, Object> getBindings()

public CompilerConfiguration getCompilerConfiguration()

public GroovyEngine getEngine()

public GroovyshOptions.ErrorHandler getErrorHandler()

public List<org.jline.shell.CommandGroup> getGroups()

public Path getHistoryFile()

public BiConsumer<org.jline.reader.LineReader, GroovySystemRegistry> getOnReaderReady()

public Supplier<String> getPrompt()

public GroovyshOptions.ResultHandler getResultHandler()

public Supplier<String> getRightPrompt()

public Terminal getTerminal()

public boolean isShowBanner()