net.sourceforge.plantuml
Enum FileFormat

java.lang.Object
  java.lang.Enum<FileFormat>
      net.sourceforge.plantuml.FileFormat

All Implemented Interfaces:

Serializable, Comparable<FileFormat>

public enum FileFormat
extends Enum<FileFormat>

Format for output files generated by PlantUML.

Author:

Arnaud Roques

Enum Constant Summary

ATXT

EPS

EPS_TEXT

HTML

HTML5

MJPEG

PDF

PNG

SVG

UTXT

VDX

XMI_ARGO

XMI_STANDARD

XMI_STAR

Method Summary

String	changeName(String fileName, int cpt)
File	computeFilename(File pngFile, int i)
String	computeFilename(String name, int i)
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(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

PDF

public static final FileFormat PDF

MJPEG

public static final FileFormat MJPEG

HTML

public static final FileFormat HTML

HTML5

public static final FileFormat HTML5

VDX

public static final FileFormat VDX

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(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:

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

NullPointerException - if the argument is null

getFileSuffix

public String getFileSuffix()

Returns the file format to be used for that format.

Returns:

a string starting by a point.

isEps

public boolean isEps()

Check if this file format is Encapsulated PostScript.

Returns:

true for EPS.

changeName

public String changeName(String fileName,
                         int cpt)

computeFilename

public File computeFilename(File pngFile,
                            int i)

computeFilename

public String computeFilename(String name,
                              int i)