org.revapi

Enum DifferenceSeverity

java.lang.Object

java.lang.Enum<DifferenceSeverity>

org.revapi.DifferenceSeverity

All Implemented Interfaces:

Serializable, Comparable<DifferenceSeverity>

public enum DifferenceSeverity
extends Enum<DifferenceSeverity>

Enumerates the possible severities of differences found during the API analysis.

The difference doesn't have a single severity, rather it can have different severity for each CompatibilityType.

Since:

0.1

Author:

Lukas Krejci

Enum Constant Summary

Enum Constants

Enum Constant and Description
BREAKING The difference definitely breaks the compatibility of given type.
EQUIVALENT The difference doesn't produce any visible change from the user's perspective.
NON_BREAKING The difference doesn't cause any breakage in given compatibility type
POTENTIALLY_BREAKING Under certain circumstances the difference is breaking the compatibility of given type.

Method Summary

Modifier and Type	Method and Description
static DifferenceSeverity	fromCamelCase(String camelCaseValue) Returns the difference severity represented by the provided string in camel case.
static DifferenceSeverity	valueOf(String name) Returns the enum constant of this type with the specified name.
static DifferenceSeverity[]	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

EQUIVALENT

public static final DifferenceSeverity EQUIVALENT

The difference doesn't produce any visible change from the user's perspective.

NON_BREAKING

public static final DifferenceSeverity NON_BREAKING

The difference doesn't cause any breakage in given compatibility type

POTENTIALLY_BREAKING

public static final DifferenceSeverity POTENTIALLY_BREAKING

Under certain circumstances the difference is breaking the compatibility of given type.

BREAKING

public static final DifferenceSeverity BREAKING

The difference definitely breaks the compatibility of given type.

Method Detail

values

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

Returns:

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

valueOf

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

fromCamelCase

public static DifferenceSeverity fromCamelCase(String camelCaseValue)

Returns the difference severity represented by the provided string in camel case. I.e. "nonBreaking" parses to NON_BREAKING, etc.

Parameters:

camelCaseValue - the value in camel case

Returns:

the corresponding difference severity instance