org.opennms.web.rest.api

Enum ApiVersion

java.lang.Object

java.lang.Enum<ApiVersion>

org.opennms.web.rest.api.ApiVersion

All Implemented Interfaces:

Serializable, Comparable<ApiVersion>

public enum ApiVersion
extends Enum<ApiVersion>

The Version of the Rest-API. Should point the user to the right url scheme.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Version1
Version2

Method Summary

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

Version1

public static final ApiVersion Version1

Version2

public static final ApiVersion Version2

Method Detail

values

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

Returns:

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

valueOf

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

getContextPath

public String getContextPath()