Module com.github.sormuras.bach

Package com.github.sormuras.bach

Class Logbook

java.lang.Object

com.github.sormuras.bach.Logbook

public class Logbook
extends Object

A logbook collects notes, prints them, and is able to write itself into a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Logbook.CaptionNote	A textual note starting a section of notes.
static final record	Logbook.MessageNote	A weighted textual note.
static interface	Logbook.Note	An abstract logbook entry.
static final record	Logbook.ToolCallNote	A note indicating that a tool is about to be called.
static final record	Logbook.ToolRunNote	A note indicating that a tool was run with a detailed description.
static interface	Logbook.Trait	An interface declaring default methods operating on an instance of Logbook.

Constructor Summary

Constructors

Constructor	Description
Logbook(Bach bach)

Method Summary

Modifier and Type	Method	Description
void	logCaption(String line)
void	logMessage(System.Logger.Level level, String text)
protected void	print(Logbook.CaptionNote note)
protected void	print(Logbook.MessageNote note)
protected void	print(Logbook.ToolCallNote note)
protected void	print(Logbook.ToolRunNote note)
void	print(ToolRun run)
static String	sanitize(Object object)
String	toMarkdown()
Duration	uptime()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Logbook

public Logbook(Bach bach)

Method Details

uptime

public Duration uptime()

logCaption

public void logCaption(String line)

logMessage

public void logMessage(System.Logger.Level level,
 String text)

print

protected void print(Logbook.CaptionNote note)

print

protected void print(Logbook.MessageNote note)

print

protected void print(Logbook.ToolCallNote note)

print

protected void print(Logbook.ToolRunNote note)

print

public void print(ToolRun run)

toMarkdown

public String toMarkdown()

sanitize

public static String sanitize(Object object)