Java workspace builder API

Edit this page on GitHub

libtmux-workspace 0.0.1-alpha.12-SNAPSHOT · Source

The io.github.libtmux.workspace package exposes the builder facade and configuration records. Applications can parse YAML or construct the records before building through a core Server.

Builder facadeLink to section

WorkspaceBuilder provides three static entry points:

• read(Path) reads a YAML file and wraps I/O errors in UncheckedIOException.
• parse(String) reads YAML text and rejects invalid descriptions.
• build(Server, Workspace) creates the session and returns a refreshed handle.

Parsing and reading do not contact tmux. Build-time checks include the target server’s support for the requested layout.

Configuration recordsLink to section

Workspace holds the session name and ordered windows. WindowSpec holds the name, optional layout, and panes. PaneSpec holds the ordered shell commands.

These records copy their lists so later changes to an input list do not alter a description already constructed. They describe the supported Java subset; they are not Python plugin or tmuxp runtime extension interfaces.

Errors and lifetimeLink to section

Invalid configuration raises IllegalArgumentException. Build failures keep the original exception and attach cleanup failures as suppressed exceptions. The caller retains ownership of the supplied server and the successful session. Use the core session API for later inspection or removal.

Public builder contract