Module io.cloudevents.api

Package io.cloudevents

Enum Class SpecVersion

java.lang.Object

java.lang.Enum<SpecVersion>

io.cloudevents.SpecVersion

All Implemented Interfaces:

Serializable, Comparable<SpecVersion>, Constable

@ParametersAreNonnullByDefault
public enum SpecVersion
extends Enum<SpecVersion>

Represents one of the supported CloudEvents specification versions by this library

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
V03
V1

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllAttributes()
Set<String>	getMandatoryAttributes()
Set<String>	getOptionalAttributes()
static SpecVersion	parse(String sv)	Parse a string as SpecVersion
String	toString()
static SpecVersion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SpecVersion[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

V03

public static final SpecVersion V03

See Also:

• CloudEvents release v0.3

V1

public static final SpecVersion V1

See Also:

• CloudEvents release v1.0

Method Details

values

public static SpecVersion[] 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 SpecVersion 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

toString

public String toString()

Overrides:

toString in class Enum<SpecVersion>

parse

public static SpecVersion parse(String sv)

Parse a string as SpecVersion

Parameters:

sv - String representing the spec version

Returns:

The parsed spec version

Throws:

CloudEventRWException - When the spec version string is unrecognized

getMandatoryAttributes

public Set<String> getMandatoryAttributes()

Returns:

mandatory attributes of the spec version

getOptionalAttributes

public Set<String> getOptionalAttributes()

Returns:

optional attributes of the spec version

getAllAttributes

public Set<String> getAllAttributes()

Returns:

all attributes for this spec