net.sourceforge.plantuml

Enum FileFormat

java.lang.Object

java.lang.Enum<FileFormat>

net.sourceforge.plantuml.FileFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileFormat>

public enum FileFormat
extends java.lang.Enum<FileFormat>

Format for output files generated by PlantUML.

Author:

Arnaud Roques

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANIMATED_GIF
ATXT
BASE64
BRAILLE_PNG
EPS
EPS_TEXT
HTML
HTML5
LATEX
LATEX_NO_PREAMBLE
MJPEG
PDF
PNG
PREPROC
SCXML
SVG
UTXT
VDX
XMI_ARGO
XMI_STANDARD
XMI_STAR

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Graphics2D	gg

Method Summary

Modifier and Type	Method and Description
java.lang.String	changeName(java.lang.String fileName, int cpt)
boolean	doesSupportMetadata()
boolean	equalsMetadata(java.lang.String currentMetadata, SFile existingFile)
StringBounder	getDefaultStringBounder(TikzFontDistortion tikzFontDistortion)
java.lang.String	getFileSuffix() Returns the file format to be used for that format.
boolean	isEps() Check if this file format is Encapsulated PostScript.
static FileFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FileFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PNG

public static final FileFormat PNG

SVG

public static final FileFormat SVG

EPS

public static final FileFormat EPS

EPS_TEXT

public static final FileFormat EPS_TEXT

ATXT

public static final FileFormat ATXT

UTXT

public static final FileFormat UTXT

XMI_STANDARD

public static final FileFormat XMI_STANDARD

XMI_STAR

public static final FileFormat XMI_STAR

XMI_ARGO

public static final FileFormat XMI_ARGO

SCXML

public static final FileFormat SCXML

PDF

public static final FileFormat PDF

MJPEG

public static final FileFormat MJPEG

ANIMATED_GIF

public static final FileFormat ANIMATED_GIF

HTML

public static final FileFormat HTML

HTML5

public static final FileFormat HTML5

VDX

public static final FileFormat VDX

LATEX

public static final FileFormat LATEX

LATEX_NO_PREAMBLE

public static final FileFormat LATEX_NO_PREAMBLE

BASE64

public static final FileFormat BASE64

BRAILLE_PNG

public static final FileFormat BRAILLE_PNG

PREPROC

public static final FileFormat PREPROC

Field Detail

gg

public static final java.awt.Graphics2D gg

Method Detail

values

public static FileFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileFormat c : FileFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileFormat valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getFileSuffix

public java.lang.String getFileSuffix()

Returns the file format to be used for that format.

Returns:

a string starting by a point.

getDefaultStringBounder

public StringBounder getDefaultStringBounder(TikzFontDistortion tikzFontDistortion)

isEps

public boolean isEps()

Check if this file format is Encapsulated PostScript.

Returns:

true for EPS.

changeName

public java.lang.String changeName(java.lang.String fileName,
                                   int cpt)

doesSupportMetadata

public boolean doesSupportMetadata()

equalsMetadata

public boolean equalsMetadata(java.lang.String currentMetadata,
                              SFile existingFile)