Package nl.talsmasoftware.umldoclet.configuration

Enum Class ImageConfig.Format

java.lang.Object

java.lang.Enum<ImageConfig.Format>

nl.talsmasoftware.umldoclet.configuration.ImageConfig.Format

All Implemented Interfaces:

Serializable, Comparable<ImageConfig.Format>, java.lang.constant.Constable

Enclosing interface:

ImageConfig

public static enum ImageConfig.Format
extends Enum<ImageConfig.Format>

Supported image formats.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EPS	Value to indicate UML diagrams must be rendered as EPS (Encapsulated Postscript) images.
PNG	Value to indicate UML diagrams must be rendered as PNG (Portable Network Graphics) images.
SVG	Value to indicate UML diagrams must be rendered as SVG (scalable vector graphics) images.

Method Summary

Modifier and Type	Method	Description
static ImageConfig.Format	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImageConfig.Format[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SVG

public static final ImageConfig.Format SVG

Value to indicate UML diagrams must be rendered as SVG (scalable vector graphics) images.

This format is the default and recommended format, as they have the following advantages over the other formats:

• Size. UML diagrams can be represented as compact SVG images.
• Scalability. SVG images can be scaled almost without limits.
• Links. SVG images allow us to embed links in the UML diagrams.

PNG

public static final ImageConfig.Format PNG

Value to indicate UML diagrams must be rendered as PNG (Portable Network Graphics) images.

This is a raster-graphics format that supports lossless compression. This format is usually only used if SVG is not an option.

EPS

public static final ImageConfig.Format EPS

Value to indicate UML diagrams must be rendered as EPS (Encapsulated Postscript) images.

This format is most appropriate for print.

Method Details

values

public static ImageConfig.Format[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ImageConfig.Format valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null