org.eclipse.californium.scandium.dtls

Class ProtocolVersion

java.lang.Object

org.eclipse.californium.scandium.dtls.ProtocolVersion

All Implemented Interfaces:

Comparable<ProtocolVersion>

public class ProtocolVersion
extends Object
implements Comparable<ProtocolVersion>

Represents the DTLS protocol version. Note that the major and minor version numbers are represented as the 1's complement of the corresponding DTLS version numbers, e.g. DTLS version 1.2 is represented as bytes {254, 253}. See Datagram Transport Layer Security Version 1.2 (RFC 6347), Section 4.1 for details.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAJOR_1 Major version for DTLS 1.x.
static int	MAJOR_1_2 Deprecated. use MAJOR_1
static int	MINOR_0 Minor version for DTLS x.0.
static int	MINOR_1_2 Deprecated. use MINOR_2
static int	MINOR_2 Minor version for DTLS x.2.
static ProtocolVersion	VERSION_DTLS_1_0 Protocol version DTLS 1.0
static ProtocolVersion	VERSION_DTLS_1_2 Protocol version DTLS 1.2

Constructor Summary

Constructors

Constructor and Description
ProtocolVersion() Deprecated. use VERSION_DTLS_1_2 or valueOf(int, int) instead.
ProtocolVersion(int major, int minor) Deprecated. intended to became private. Use valueOf(int, int) instead.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ProtocolVersion o) Compares this protocol version to another one.
boolean	equals(Object obj)
int	getMajor()
int	getMinor()
int	hashCode()
String	toString()
static ProtocolVersion	valueOf(int major, int minor) Get protocol version value of the provided versions.
static ProtocolVersion	valueOf(String version) Get protocol version value of the provided versions.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAJOR_1

public static final int MAJOR_1

Major version for DTLS 1.x.

Since:

2.5

See Also:

Constant Field Values

MINOR_2

public static final int MINOR_2

Minor version for DTLS x.2.

Since:

2.5

See Also:

Constant Field Values

MINOR_0

public static final int MINOR_0

Minor version for DTLS x.0.

Since:

2.5

See Also:

Constant Field Values

MAJOR_1_2

@Deprecated
public static final int MAJOR_1_2

Deprecated. use MAJOR_1

Major version for DTLS 1.2.

Since:

2.4

See Also:

Constant Field Values

MINOR_1_2

@Deprecated
public static final int MINOR_1_2

Deprecated. use MINOR_2

Minor version for DTLS 1.2.

Since:

2.4

See Also:

Constant Field Values

VERSION_DTLS_1_2

public static final ProtocolVersion VERSION_DTLS_1_2

Protocol version DTLS 1.2

Since:

2.4

VERSION_DTLS_1_0

public static final ProtocolVersion VERSION_DTLS_1_0

Protocol version DTLS 1.0

Since:

2.5

Constructor Detail

ProtocolVersion

@Deprecated
public ProtocolVersion()

Deprecated. use VERSION_DTLS_1_2 or valueOf(int, int) instead.

Creates an instance representing DTLS version 1.2. The version is represented as {254, 253} (1's complement of {1, 2}).

ProtocolVersion

@Deprecated
public ProtocolVersion(int major,
                          int minor)

Deprecated. intended to became private. Use valueOf(int, int) instead.

Instantiates a new protocol version.

Parameters:

major - the major

minor - the minor

Method Detail

getMinor

public int getMinor()

getMajor

public int getMajor()

compareTo

public int compareTo(ProtocolVersion o)

Compares this protocol version to another one. Note that the comparison is done based on the semantic version, i.e. DTLS protocol version 1.0 (represented as major 254, minor 255) is considered lower than 1.2 (represented as major 254, minor 253) whereas the byte values representing version 1.0 are actually larger.

Specified by:

compareTo in interface Comparable<ProtocolVersion>

Parameters:

o - the protocol version to compare to

Returns:

0 if this version is exactly the same as the other version, -1 if this version is lower than the other version or 1 if this version is higher than the other version

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static ProtocolVersion valueOf(int major,
                      int minor)

Get protocol version value of the provided versions.

Parameters:

major - major version

minor - minor version

Returns:

protocol version

valueOf

public static ProtocolVersion valueOf(String version)

Get protocol version value of the provided versions.

Parameters:

version - textual version. e.g. "1.2".

Returns:

protocol version

Since:

2.6