io.github.libtmux.workspace.WorkspaceBuilder.WorkspaceBuilder

Java

Python Unavailable
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust Unavailable
Go Unavailable
Java
.NET Unavailable
C++ Unavailable
Swift Unavailable

class io.github.libtmux.workspace.WorkspaceBuilder.WorkspaceBuilder classreadonly [source] ¶ classreadonly [source] ¶ class io.github.libtmux.workspace.WorkspaceBuilder.WorkspaceBuilder

Builds a tmux session from a written description.

Reads the shape of a tmuxp workspace file. Full runtime compatibility with tmuxp is not the aim; starting from a file somebody already has is.

Reading and building are separate. A file that describes something tmux would refuse is rejected while it is still text, before any session exists to leave half-built.

Discussed in Java workspace internals , Java workspace builder examples , Java workspace builder API

Members

read

read ( file : Path ) → Workspace methodstatic [source] ¶ methodstatic [source] ¶ read

Reads a workspace from a file.

Discussed in Use the Java workspace builder , Java workspace builder behavior , Java workspace builder API

parse

parse ( yaml : String ) → Workspace methodstatic [source] ¶ methodstatic [source] ¶ parse

Reads a workspace from YAML text.

Raises

IllegalArgumentException – if the description is one tmux could not build, including a layout name tmux would not recognise

Discussed in Java workspace builder behavior , Java workspace builder API

build

build ( server : Server , workspace : Workspace ) → Session methodstatic [source] ¶ methodstatic [source] ¶ build

Creates the described session on a server.

Returns: the session, from a capture taken once everything exists

Discussed in Use the Java workspace builder , Java workspace builder behavior , Java workspace builder API

In other ports Build a session from a workspace description

Python tmuxp.workspace.builder.ClassicWorkspaceBuilder.build
Ruby LibTmux::Workspace::Plan#apply
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript builder.applyWorkspace
Rust src.WorkspaceBuilder.build
Go workspace.Build
.NET LibTmux.Workspace.WorkspaceBuilder.BuildAsync
C++ libtmux::workspace::build
Swift WorkspaceBuilder.build(_:on:)