Package org.opendaylight.yangtools.yang.common

Enum YangVersion

java.lang.Object

java.lang.Enum<YangVersion>

org.opendaylight.yangtools.yang.common.YangVersion

All Implemented Interfaces:

Serializable, Comparable<YangVersion>

@Beta
public enum YangVersion
extends Enum<YangVersion>

Enumeration of supported YANG versions.

Author:

Robert Varga

Enum Constant Summary

Enum Constants

Enum Constant	Description
VERSION_1	Version 1, as defined in RFC6020.
VERSION_1_1	Version 1.1, as defined in RFC7950.

Method Summary

Modifier and Type	Method	Description
@NonNull String	getReference()	Return the normative reference defining this YANG version.
static Optional<YangVersion>	parse(@NonNull String str)	Parse a YANG version from its textual representation.
@NonNull String	toString()
static YangVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static YangVersion[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERSION_1

public static final YangVersion VERSION_1

Version 1, as defined in RFC6020.

VERSION_1_1

public static final YangVersion VERSION_1_1

Version 1.1, as defined in RFC7950.

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static Optional<YangVersion> parse(@NonNull String str)

Parse a YANG version from its textual representation.

Parameters:

str - String to parse

Returns:

YANG version

Throws:

NullPointerException - if the string is null

getReference

public @NonNull String getReference()

Return the normative reference defining this YANG version.

Returns:

Normative reference.

toString

public @NonNull String toString()

Overrides:

toString in class Enum<YangVersion>