Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.io

Interface OutputFormat

All Known Implementing Classes:

BitmapExportOutputFormat, SimpleXmlWriter, XmlEncoderOutputFormat

public interface OutputFormat

OutputFormat.

Author:

Werner Randelshofer

Method Summary

Modifier and Type	Method	Description
@NonNull ImmutableMap<Key<?>,Object>	getOptions()
void	setOptions(@NonNull ImmutableMap<Key<?>,Object> newValue)
void	write(@NonNull OutputStream out, @Nullable URI documentHome, @NonNull Drawing drawing, @NonNull WorkState<Void> workState)	Writes a Drawing into an output stream.
default void	write(@NonNull URI uri, @NonNull Drawing drawing, @NonNull WorkState<Void> workState)	Writes a Drawing into the resource identified by the given URI.
default void	write(@NonNull Path file, @NonNull Drawing drawing, @NonNull WorkState<Void> workState)	Writes the drawing to the specified file.

Method Details

setOptions

void setOptions(@NonNull ImmutableMap<Key<?>,Object> newValue)

getOptions

@NonNull ImmutableMap<Key<?>,Object> getOptions()

write

default void write(@NonNull URI uri,
 @NonNull Drawing drawing,
 @NonNull WorkState<Void> workState)
            throws IOException

Writes a Drawing into the resource identified by the given URI.

Parameters:

uri - The resource identifier

drawing - The drawing.

workState - for progress monitoring and cancelling the operation

Throws:

IOException - if an IO error occurs

write

default void write(@NonNull Path file,
 @NonNull Drawing drawing,
 @NonNull WorkState<Void> workState)
            throws IOException

Writes the drawing to the specified file. This method ensures that all figures of the drawing are visible on the image.

Parameters:

file - the file

drawing - the drawing

workState - for progress monitoring and cancelling the operation

Throws:

IOException - if an IO error occurs

write

void write(@NonNull OutputStream out,
 @Nullable URI documentHome,
 @NonNull Drawing drawing,
 @NonNull WorkState<Void> workState)
    throws IOException

Writes a Drawing into an output stream.

Parameters:

out - The output stream.

documentHome - Document home URI for creating relative URIs in the document if this URI is null, all URIs in the document will be absolute

drawing - The drawing.

workState - for progress monitoring and cancelling the operation

Throws:

IOException - if an IO error occurs