org.cyclonedx

Enum Format

java.lang.Object

java.lang.Enum<Format>

org.cyclonedx.Format

All Implemented Interfaces:

Serializable, Comparable<Format>

public enum Format
extends Enum<Format>

Enum Constant Summary

Enum Constants

Enum Constant and Description
JSON
XML

Method Summary

Modifier and Type	Method and Description
static Format	fromExtension(String extension) Returns the format based on the given file extension.
String	getExtension() The file extension associated to this format.
String	getMediaType() The official CycloneDX media type assigned by IANA for this format, see ...
static Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static Format[]	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

XML

public static final Format XML

JSON

public static final Format JSON

Method Detail

values

public static Format[] 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 (Format c : Format.values())
    System.out.println(c);

Returns:

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

valueOf

public static Format 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

getExtension

public String getExtension()

The file extension associated to this format.

Returns:

The file extension, excluding the dot.

getMediaType

public String getMediaType()

The official CycloneDX media type assigned by IANA for this format, see ....

Returns:

The identifier for the media type.

fromExtension

public static Format fromExtension(String extension)

Returns the format based on the given file extension.

Parameters:

extension - The file extension.

Returns:

The format or null if not found.