Module org.tquadrat.foundation.svg

Package org.tquadrat.foundation.svg

Enum Class SVG.Usage

java.lang.Object

java.lang.Enum<SVG.Usage>

org.tquadrat.foundation.svg.SVG.Usage

All Implemented Interfaces:

Serializable, Comparable<SVG.Usage>, Constable

Enclosing interface:

SVG

@ClassVersion(sourceVersion="$Id: SVG.java 1139 2024-06-16 19:50:41Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public static enum SVG.Usage
extends Enum<SVG.Usage>

The different usages for an <svg> element.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: SVG.java 1139 2024-06-16 19:50:41Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.svg.SVG.Usage"

⁠

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
EMBED_HTML	The <svg> element will be embedded into HTML (but not HTML 5 - see EMBED_HTML5).
EMBED_HTML5	The <svg> element will be embedded into HTML 5; as SVG is somehow part of the definition of HTML 5, no further namespace declarations are required.
EMBED_SVG	The <svg> element will be embedded into another <svg> element.
STANDALONE_DOCUMENT	The <svg> element is used as the root for a stand-alone document.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Usage()

Method Summary

Modifier and Type	Method	Description
static SVG.Usage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SVG.Usage[]	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

STANDALONE_DOCUMENT

@API(status=STABLE,
     since="0.0.5")
public static final SVG.Usage STANDALONE_DOCUMENT

The <svg> element is used as the root for a stand-alone document.

EMBED_HTML

@API(status=STABLE,
     since="0.0.5")
public static final SVG.Usage EMBED_HTML

The <svg> element will be embedded into HTML (but not HTML 5 - see EMBED_HTML5).

EMBED_HTML5

@API(status=STABLE,
     since="0.0.5")
public static final SVG.Usage EMBED_HTML5

The <svg> element will be embedded into HTML 5; as SVG is somehow part of the definition of HTML 5, no further namespace declarations are required.

EMBED_SVG

@API(status=STABLE,
     since="0.0.5")
public static final SVG.Usage EMBED_SVG

The <svg> element will be embedded into another <svg> element.

Constructor Details

Usage

private Usage()

Method Details

values

public static SVG.Usage[] 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 SVG.Usage 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