com.simiacryptus.notebook

Class NullNotebookOutput

java.lang.Object

com.simiacryptus.notebook.NullNotebookOutput

All Implemented Interfaces:

NotebookOutput, Closeable, AutoCloseable

public class NullNotebookOutput
extends Object
implements NotebookOutput

The type Null notebook output.

Constructor Summary

Constructors

Constructor and Description
NullNotebookOutput() Instantiates a new Null notebook output.
NullNotebookOutput(String name) Instantiates a new Null notebook output.

Method Summary

Modifier and Type	Method and Description
void	close()
<T> T	eval(UncheckedSupplier<T> fn, int maxLog, int framesNo) Code t.
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.
URI	getArchiveHome() Gets archive home.
URI	getCurrentHome() Gets current home.
CharSequence	getFrontMatterProperty(CharSequence key) Gets front matter property.
FileHTTPD	getHttpd() Gets httpd.
int	getMaxOutSize() Gets max out size.
CharSequence	getName() Gets name.
File	getResourceDir() Gets resource dir.
File	getRoot() Gets root.
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	jpg(BufferedImage rawImage, CharSequence caption) Jpg string.
File	jpgFile(BufferedImage rawImage, File file) Jpg file file.
CharSequence	link(File file, CharSequence text) Link string.
NotebookOutput	onComplete(Runnable... tasks) On complete notebook output.
void	p(CharSequence fmt, Object... args) P.
String	png(BufferedImage rawImage, CharSequence caption) Image string.
File	pngFile(BufferedImage rawImage, File file) Png file file.
NotebookOutput	setArchiveHome(URI archiveHome) Sets archive home.
NotebookOutput	setAutobrowse(boolean autobrowse) Sets autobrowse.
NotebookOutput	setCurrentHome(URI currentHome) Sets current home.
NotebookOutput	setName(String name) Sets name.
<T> T	subreport(String reportName, Function<NotebookOutput,T> fn) Subreport t.
void	write() Write.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.simiacryptus.notebook.NotebookOutput

appendFrontMatterProperty, concat, eval, out, out, run, setFrontMatterProperty

Constructor Detail

NullNotebookOutput

public NullNotebookOutput(String name)

Instantiates a new Null notebook output.

Parameters:

name - the name

NullNotebookOutput

public NullNotebookOutput()

Instantiates a new Null notebook output.

Method Detail

close

public void close()

Specified by:

close in interface NotebookOutput

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

pngFile

@Nonnull
public File pngFile(@Nonnull
                             BufferedImage rawImage,
                             File file)

Description copied from interface: NotebookOutput

Png file file.

Specified by:

pngFile in interface NotebookOutput

Parameters:

rawImage - the raw image

file - the file

Returns:

the file

jpg

@Nonnull
public String jpg(@Nullable
                           BufferedImage rawImage,
                           CharSequence caption)

Description copied from interface: NotebookOutput

Jpg string.

Specified by:

jpg in interface NotebookOutput

Parameters:

rawImage - the raw image

caption - the caption

Returns:

the string

jpgFile

@Nonnull
public File jpgFile(@Nonnull
                             BufferedImage rawImage,
                             File file)

Description copied from interface: NotebookOutput

Jpg file file.

Specified by:

jpgFile in interface NotebookOutput

Parameters:

rawImage - the raw image

file - the file

Returns:

the file

eval

public <T> T eval(@Nonnull
                  UncheckedSupplier<T> fn,
                  int maxLog,
                  int framesNo)

Description copied from interface: NotebookOutput

Code t.

Specified by:

eval in interface NotebookOutput

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

maxLog - the max log

framesNo - the frames no

Returns:

the t

write

public void write()

Description copied from interface: NotebookOutput

Write.

Specified by:

write in interface NotebookOutput

file

@Nonnull
public OutputStream file(@Nonnull
                                  CharSequence name)

Description copied from interface: NotebookOutput

File output stream.

Specified by:

file in interface NotebookOutput

Parameters:

name - the name

Returns:

the output stream

file

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

Description copied from interface: NotebookOutput

File string.

Specified by:

file in interface NotebookOutput

Parameters:

data - the data

caption - the caption

Returns:

the string

file

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

Description copied from interface: NotebookOutput

File string.

Specified by:

file in interface NotebookOutput

Parameters:

data - the data

filename - the filename

caption - the caption

Returns:

the string

file

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

Description copied from interface: NotebookOutput

File string.

Specified by:

file in interface NotebookOutput

Parameters:

data - the data

fileName - the file name

caption - the caption

Returns:

the string

h1

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

Description copied from interface: NotebookOutput

H 1.

Specified by:

h1 in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

h2

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

Description copied from interface: NotebookOutput

H 2.

Specified by:

h2 in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

h3

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

Description copied from interface: NotebookOutput

H 3.

Specified by:

h3 in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

png

@Nonnull
public String png(BufferedImage rawImage,
                           CharSequence caption)

Description copied from interface: NotebookOutput

Image string.

Specified by:

png in interface NotebookOutput

Parameters:

rawImage - the raw png

caption - the caption

Returns:

the string

link

@Nonnull
public CharSequence link(File file,
                                  CharSequence text)

Description copied from interface: NotebookOutput

Link string.

Specified by:

link in interface NotebookOutput

Parameters:

file - the file

text - the text

Returns:

the string

p

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

Description copied from interface: NotebookOutput

P.

Specified by:

p in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

getRoot

@Nonnull
public File getRoot()

Description copied from interface: NotebookOutput

Gets root.

Specified by:

getRoot in interface NotebookOutput

Returns:

the root

onComplete

@Nonnull
public NotebookOutput onComplete(Runnable... tasks)

Description copied from interface: NotebookOutput

On complete notebook output.

Specified by:

onComplete in interface NotebookOutput

Parameters:

tasks - the tasks

Returns:

the notebook output

getFrontMatterProperty

@Nullable
public CharSequence getFrontMatterProperty(CharSequence key)

Description copied from interface: NotebookOutput

Gets front matter property.

Specified by:

getFrontMatterProperty in interface NotebookOutput

Parameters:

key - the key

Returns:

the front matter property

getName

public CharSequence getName()

Description copied from interface: NotebookOutput

Gets name.

Specified by:

getName in interface NotebookOutput

Returns:

the name

getResourceDir

@Nonnull
public File getResourceDir()

Description copied from interface: NotebookOutput

Gets resource dir.

Specified by:

getResourceDir in interface NotebookOutput

Returns:

the resource dir

getMaxOutSize

public int getMaxOutSize()

Description copied from interface: NotebookOutput

Gets max out size.

Specified by:

getMaxOutSize in interface NotebookOutput

Returns:

the max out size

getHttpd

public FileHTTPD getHttpd()

Description copied from interface: NotebookOutput

Gets httpd.

Specified by:

getHttpd in interface NotebookOutput

Returns:

the httpd

subreport

public <T> T subreport(String reportName,
                       Function<NotebookOutput,T> fn)

Description copied from interface: NotebookOutput

Subreport t.

Specified by:

subreport in interface NotebookOutput

Type Parameters:

T - the type parameter

Parameters:

reportName - the report name

fn - the fn

Returns:

the t

getCurrentHome

public URI getCurrentHome()

Description copied from interface: NotebookOutput

Gets current home.

Specified by:

getCurrentHome in interface NotebookOutput

Returns:

the current home

setCurrentHome

public NotebookOutput setCurrentHome(URI currentHome)

Description copied from interface: NotebookOutput

Sets current home.

Specified by:

setCurrentHome in interface NotebookOutput

Parameters:

currentHome - the current home

Returns:

the current home

getArchiveHome

public URI getArchiveHome()

Description copied from interface: NotebookOutput

Gets archive home.

Specified by:

getArchiveHome in interface NotebookOutput

Returns:

the archive home

setArchiveHome

public NotebookOutput setArchiveHome(URI archiveHome)

Description copied from interface: NotebookOutput

Sets archive home.

Specified by:

setArchiveHome in interface NotebookOutput

Parameters:

archiveHome - the archive home

Returns:

the archive home

setName

public NotebookOutput setName(String name)

Description copied from interface: NotebookOutput

Sets name.

Specified by:

setName in interface NotebookOutput

Parameters:

name - the name

Returns:

the name

setAutobrowse

public NotebookOutput setAutobrowse(boolean autobrowse)

Description copied from interface: NotebookOutput

Sets autobrowse.

Specified by:

setAutobrowse in interface NotebookOutput

Parameters:

autobrowse - the autobrowse

Returns:

the autobrowse