com.simiacryptus.util.io

Interface NotebookOutput

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

HtmlNotebookOutput, MarkdownNotebookOutput, NullNotebookOutput

public interface NotebookOutput
extends Closeable

The interface Notebook output.

Method Summary

Modifier and Type	Method and Description
default void	appendFrontMatterProperty(CharSequence key, CharSequence value, CharSequence delimiter) Append front matter property.
default void	code(Runnable fn) Code.
default <T> T	code(UncheckedSupplier<T> fn) Code t.
<T> T	code(UncheckedSupplier<T> fn, int maxLog, int framesNo) Code t.
static java.util.function.Consumer<NotebookOutput>	concat(java.util.function.Consumer<NotebookOutput> fn, java.util.function.Consumer<NotebookOutput> header) Concat consumer.
CharSequence	file(byte[] data, CharSequence filename, CharSequence caption) File string.
OutputStream	file(CharSequence name) File output stream.
String	file(CharSequence data, CharSequence caption) File string.
String	file(CharSequence data, CharSequence fileName, CharSequence caption) File string.
CharSequence	getFrontMatterProperty(CharSequence key) Gets front matter property.
FileNanoHTTPD	getHttpd() Gets httpd.
int	getMaxOutSize() Gets max out size.
CharSequence	getName() Gets name.
File	getResourceDir() Gets resource dir.
void	h1(CharSequence fmt, Object... args) H 1.
void	h2(CharSequence fmt, Object... args) H 2.
void	h3(CharSequence fmt, Object... args) H 3.
String	image(BufferedImage rawImage, CharSequence caption) Image string.
CharSequence	link(File file, CharSequence text) Link string.
default void	out(String fmt, Object... args) Out.
default <T> T	out(UncheckedSupplier<T> fn) Code t.
void	p(CharSequence fmt, Object... args) P.
default void	setFrontMatterProperty(CharSequence key, CharSequence value) Sets fm prop.

Methods inherited from interface java.io.Closeable

close

Method Detail

concat

static java.util.function.Consumer<NotebookOutput> concat(@Nonnull
                                                          java.util.function.Consumer<NotebookOutput> fn,
                                                          @Nonnull
                                                          java.util.function.Consumer<NotebookOutput> header)

Concat consumer.

Parameters:

fn - the fn

header - the header

Returns:

the consumer

code

default void code(@Nonnull
                  Runnable fn)

Code.

Parameters:

fn - the fn

code

default <T> T code(UncheckedSupplier<T> fn)

Code t.

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

Returns:

the t

out

default <T> T out(UncheckedSupplier<T> fn)

Code t.

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

Returns:

the t

code

<T> T code(UncheckedSupplier<T> fn,
           int maxLog,
           int framesNo)

Code t.

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

maxLog - the max log

framesNo - the frames no

Returns:

the t

file

@Nonnull
OutputStream file(CharSequence name)

File output stream.

Parameters:

name - the name

Returns:

the output stream

file

@Nonnull
String file(CharSequence data,
                     CharSequence caption)

File string.

Parameters:

data - the data

caption - the caption

Returns:

the string

file

@Nonnull
CharSequence file(byte[] data,
                           CharSequence filename,
                           CharSequence caption)

File string.

Parameters:

data - the data

filename - the filename

caption - the caption

Returns:

the string

file

@Nonnull
String file(CharSequence data,
                     CharSequence fileName,
                     CharSequence caption)

File string.

Parameters:

data - the data

fileName - the file name

caption - the caption

Returns:

the string

h1

void h1(CharSequence fmt,
        Object... args)

H 1.

Parameters:

fmt - the fmt

args - the args

h2

void h2(CharSequence fmt,
        Object... args)

H 2.

Parameters:

fmt - the fmt

args - the args

h3

void h3(CharSequence fmt,
        Object... args)

H 3.

Parameters:

fmt - the fmt

args - the args

image

@Nonnull
String image(BufferedImage rawImage,
                      CharSequence caption)

Image string.

Parameters:

rawImage - the raw image

caption - the caption

Returns:

the string

link

CharSequence link(File file,
                  CharSequence text)

Link string.

Parameters:

file - the file

text - the text

Returns:

the string

out

default void out(String fmt,
                 Object... args)

Out.

Parameters:

fmt - the fmt

args - the args

p

void p(CharSequence fmt,
       Object... args)

P.

Parameters:

fmt - the fmt

args - the args

setFrontMatterProperty

default void setFrontMatterProperty(CharSequence key,
                                    CharSequence value)

Sets fm prop.

Parameters:

key - the key

value - the value

appendFrontMatterProperty

default void appendFrontMatterProperty(CharSequence key,
                                       CharSequence value,
                                       CharSequence delimiter)

Append front matter property.

Parameters:

key - the key

value - the value

delimiter - the delimiter

getFrontMatterProperty

@Nullable
CharSequence getFrontMatterProperty(CharSequence key)

Gets front matter property.

Parameters:

key - the key

Returns:

the front matter property

getName

CharSequence getName()

Gets name.

Returns:

the name

getResourceDir

@Nonnull
File getResourceDir()

Gets resource dir.

Returns:

the resource dir

getMaxOutSize

int getMaxOutSize()

Gets max out size.

Returns:

the max out size

getHttpd

FileNanoHTTPD getHttpd()

Gets httpd.

Returns:

the httpd