Package org.revapi.java.spi

Enum Code

java.lang.Object

java.lang.Enum<Code>

org.revapi.java.spi.Code

All Implemented Interfaces:

Serializable, Comparable<Code>

public enum Code
extends Enum<Code>

The is a list of all difference codes Revapi's Java extension can emit. This can be used by others when they want to override the default detection behavior by providing custom difference transforms.

Since:

0.1

Author:

Lukas Krejci

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANNOTATION_ADDED
ANNOTATION_ATTRIBUTE_ADDED
ANNOTATION_ATTRIBUTE_REMOVED
ANNOTATION_ATTRIBUTE_VALUE_CHANGED
ANNOTATION_NO_LONGER_INHERITED
ANNOTATION_NOW_INHERITED
ANNOTATION_REMOVED
CLASS_ADDED
CLASS_DEFAULT_SERIALIZATION_CHANGED
CLASS_EXTERNAL_CLASS_EXPOSED_IN_API
CLASS_EXTERNAL_CLASS_NO_LONGER_EXPOSED_IN_API
CLASS_FINAL_CLASS_INHERITS_FROM_NEW_CLASS
CLASS_KIND_CHANGED
CLASS_NO_LONGER_ABSTRACT
CLASS_NO_LONGER_FINAL
CLASS_NO_LONGER_IMPLEMENTS_INTERFACE
CLASS_NO_LONGER_INHERITS_FROM_CLASS
CLASS_NON_FINAL_CLASS_INHERITS_FROM_NEW_CLASS
CLASS_NON_PUBLIC_PART_OF_API
CLASS_NOW_ABSTRACT
CLASS_NOW_CHECKED_EXCEPTION
CLASS_NOW_FINAL
CLASS_NOW_IMPLEMENTS_INTERFACE
CLASS_REMOVED
CLASS_SUPER_TYPE_TYPE_PARAMETERS_CHANGED
CLASS_VISIBILITY_INCREASED
CLASS_VISIBILITY_REDUCED
ELEMENT_NO_LONGER_DEPRECATED
ELEMENT_NOW_DEPRECATED
FIELD_ADDED
FIELD_ADDED_STATIC_FIELD
FIELD_CONSTANT_REMOVED
FIELD_CONSTANT_VALUE_CHANGED
FIELD_ENUM_CONSTANT_ORDER_CHANGED
FIELD_INHERITED_NOW_DECLARED
FIELD_MOVED_TO_SUPER_CLASS
FIELD_NO_LONGER_CONSTANT
FIELD_NO_LONGER_FINAL
FIELD_NO_LONGER_STATIC
FIELD_NOW_CONSTANT
FIELD_NOW_FINAL
FIELD_NOW_STATIC
FIELD_REMOVED
FIELD_SERIAL_VERSION_UID_CHANGED
FIELD_SERIAL_VERSION_UID_UNCHANGED
FIELD_TYPE_CHANGED
FIELD_VISIBILITY_INCREASED
FIELD_VISIBILITY_REDUCED
GENERICS_ELEMENT_NOW_PARAMETERIZED
GENERICS_FORMAL_TYPE_PARAMETER_ADDED
GENERICS_FORMAL_TYPE_PARAMETER_CHANGED
GENERICS_FORMAL_TYPE_PARAMETER_REMOVED
METHOD_ABSTRACT_METHOD_ADDED
METHOD_ADDED
METHOD_ADDED_TO_INTERFACE
METHOD_ATTRIBUTE_REMOVED_FROM_ANNOTATION_TYPE
METHOD_ATTRIBUTE_WITH_DEFAULT_ADDED_TO_ANNOTATION_TYPE
METHOD_ATTRIBUTE_WITH_NO_DEFAULT_ADDED_TO_ANNOTATION_TYPE
METHOD_CHECKED_EXCEPTION_ADDED
METHOD_CHECKED_EXCEPTION_REMOVED
METHOD_DEFAULT_METHOD_ADDED_TO_INTERFACE
METHOD_DEFAULT_VALUE_ADDED
METHOD_DEFAULT_VALUE_CHANGED
METHOD_DEFAULT_VALUE_REMOVED
METHOD_FINAL_METHOD_ADDED_TO_NON_FINAL_CLASS
METHOD_INHERITED_METHOD_MOVED_TO_CLASS
METHOD_MOVED_TO_SUPERCLASS
METHOD_NO_LONGER_ABSTRACT
METHOD_NO_LONGER_DEFAULT
METHOD_NO_LONGER_FINAL
METHOD_NO_LONGER_STATIC
METHOD_NOW_ABSTRACT
METHOD_NOW_DEFAULT
METHOD_NOW_FINAL
METHOD_NOW_FINAL_IN_FINAL_CLASS
METHOD_NOW_STATIC
METHOD_NUMBER_OF_PARAMETERS_CHANGED
METHOD_PARAMETER_TYPE_CHANGED
METHOD_PARAMETER_TYPE_ERASURE_CHANGED
METHOD_PARAMETER_TYPE_PARAMETER_CHANGED
METHOD_REMOVED
METHOD_RETURN_TYPE_CHANGED
METHOD_RETURN_TYPE_CHANGED_COVARIANTLY
METHOD_RETURN_TYPE_ERASURE_CHANGED
METHOD_RETURN_TYPE_TYPE_PARAMETERS_CHANGED
METHOD_RUNTIME_EXCEPTION_ADDED
METHOD_RUNTIME_EXCEPTION_REMOVED
METHOD_STATIC_METHOD_ADDED_TO_INTERFACE
METHOD_VISIBILITY_INCREASED
METHOD_VISIBILITY_REDUCED
MISSING_IN_NEW_API
MISSING_IN_OLD_API
MISSING_NEW_SUPERTYPE
MISSING_OLD_SUPERTYPE

Method Summary

Modifier and Type	Method	Description
static <T extends JavaElement> LinkedHashMap<String,String>	attachmentsFor(T oldElement, T newElement, String... customAttachments)
String	code()
org.revapi.Difference	createDifference(Locale locale)
org.revapi.Difference	createDifference(Locale locale, LinkedHashMap<String,String> attachments)
org.revapi.Difference	createDifference(Locale locale, LinkedHashMap<String,String> attachments, String... parameters)
static Code	fromCode(String code)
static Code	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Code[]	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

MISSING_IN_OLD_API

public static final Code MISSING_IN_OLD_API

MISSING_IN_NEW_API

public static final Code MISSING_IN_NEW_API

MISSING_OLD_SUPERTYPE

public static final Code MISSING_OLD_SUPERTYPE

MISSING_NEW_SUPERTYPE

public static final Code MISSING_NEW_SUPERTYPE

ELEMENT_NO_LONGER_DEPRECATED

public static final Code ELEMENT_NO_LONGER_DEPRECATED

ELEMENT_NOW_DEPRECATED

public static final Code ELEMENT_NOW_DEPRECATED

CLASS_VISIBILITY_INCREASED

public static final Code CLASS_VISIBILITY_INCREASED

CLASS_VISIBILITY_REDUCED

public static final Code CLASS_VISIBILITY_REDUCED

CLASS_KIND_CHANGED

public static final Code CLASS_KIND_CHANGED

CLASS_NO_LONGER_FINAL

public static final Code CLASS_NO_LONGER_FINAL

CLASS_NOW_FINAL

public static final Code CLASS_NOW_FINAL

CLASS_NO_LONGER_ABSTRACT

public static final Code CLASS_NO_LONGER_ABSTRACT

CLASS_NOW_ABSTRACT

public static final Code CLASS_NOW_ABSTRACT

CLASS_ADDED

public static final Code CLASS_ADDED

CLASS_REMOVED

public static final Code CLASS_REMOVED

CLASS_NO_LONGER_IMPLEMENTS_INTERFACE

public static final Code CLASS_NO_LONGER_IMPLEMENTS_INTERFACE

CLASS_NOW_IMPLEMENTS_INTERFACE

public static final Code CLASS_NOW_IMPLEMENTS_INTERFACE

CLASS_FINAL_CLASS_INHERITS_FROM_NEW_CLASS

public static final Code CLASS_FINAL_CLASS_INHERITS_FROM_NEW_CLASS

CLASS_NON_FINAL_CLASS_INHERITS_FROM_NEW_CLASS

public static final Code CLASS_NON_FINAL_CLASS_INHERITS_FROM_NEW_CLASS

CLASS_NOW_CHECKED_EXCEPTION

public static final Code CLASS_NOW_CHECKED_EXCEPTION

CLASS_NO_LONGER_INHERITS_FROM_CLASS

public static final Code CLASS_NO_LONGER_INHERITS_FROM_CLASS

CLASS_NON_PUBLIC_PART_OF_API

public static final Code CLASS_NON_PUBLIC_PART_OF_API

CLASS_SUPER_TYPE_TYPE_PARAMETERS_CHANGED

public static final Code CLASS_SUPER_TYPE_TYPE_PARAMETERS_CHANGED

CLASS_EXTERNAL_CLASS_EXPOSED_IN_API

public static final Code CLASS_EXTERNAL_CLASS_EXPOSED_IN_API

CLASS_EXTERNAL_CLASS_NO_LONGER_EXPOSED_IN_API

public static final Code CLASS_EXTERNAL_CLASS_NO_LONGER_EXPOSED_IN_API

CLASS_DEFAULT_SERIALIZATION_CHANGED

public static final Code CLASS_DEFAULT_SERIALIZATION_CHANGED

ANNOTATION_ADDED

public static final Code ANNOTATION_ADDED

ANNOTATION_REMOVED

public static final Code ANNOTATION_REMOVED

ANNOTATION_ATTRIBUTE_VALUE_CHANGED

public static final Code ANNOTATION_ATTRIBUTE_VALUE_CHANGED

ANNOTATION_ATTRIBUTE_ADDED

public static final Code ANNOTATION_ATTRIBUTE_ADDED

ANNOTATION_ATTRIBUTE_REMOVED

public static final Code ANNOTATION_ATTRIBUTE_REMOVED

ANNOTATION_NO_LONGER_INHERITED

public static final Code ANNOTATION_NO_LONGER_INHERITED

ANNOTATION_NOW_INHERITED

public static final Code ANNOTATION_NOW_INHERITED

FIELD_ADDED_STATIC_FIELD

public static final Code FIELD_ADDED_STATIC_FIELD

FIELD_ADDED

public static final Code FIELD_ADDED

FIELD_REMOVED

public static final Code FIELD_REMOVED

FIELD_MOVED_TO_SUPER_CLASS

public static final Code FIELD_MOVED_TO_SUPER_CLASS

FIELD_INHERITED_NOW_DECLARED

public static final Code FIELD_INHERITED_NOW_DECLARED

FIELD_CONSTANT_REMOVED

public static final Code FIELD_CONSTANT_REMOVED

FIELD_CONSTANT_VALUE_CHANGED

public static final Code FIELD_CONSTANT_VALUE_CHANGED

FIELD_NOW_CONSTANT

public static final Code FIELD_NOW_CONSTANT

FIELD_NO_LONGER_CONSTANT

public static final Code FIELD_NO_LONGER_CONSTANT

FIELD_NOW_FINAL

public static final Code FIELD_NOW_FINAL

FIELD_NO_LONGER_FINAL

public static final Code FIELD_NO_LONGER_FINAL

FIELD_NO_LONGER_STATIC

public static final Code FIELD_NO_LONGER_STATIC

FIELD_NOW_STATIC

public static final Code FIELD_NOW_STATIC

FIELD_TYPE_CHANGED

public static final Code FIELD_TYPE_CHANGED

FIELD_SERIAL_VERSION_UID_UNCHANGED

public static final Code FIELD_SERIAL_VERSION_UID_UNCHANGED

FIELD_SERIAL_VERSION_UID_CHANGED

public static final Code FIELD_SERIAL_VERSION_UID_CHANGED

FIELD_VISIBILITY_INCREASED

public static final Code FIELD_VISIBILITY_INCREASED

FIELD_VISIBILITY_REDUCED

public static final Code FIELD_VISIBILITY_REDUCED

FIELD_ENUM_CONSTANT_ORDER_CHANGED

public static final Code FIELD_ENUM_CONSTANT_ORDER_CHANGED

METHOD_DEFAULT_VALUE_ADDED

public static final Code METHOD_DEFAULT_VALUE_ADDED

METHOD_DEFAULT_VALUE_CHANGED

public static final Code METHOD_DEFAULT_VALUE_CHANGED

METHOD_DEFAULT_VALUE_REMOVED

public static final Code METHOD_DEFAULT_VALUE_REMOVED

METHOD_ADDED_TO_INTERFACE

public static final Code METHOD_ADDED_TO_INTERFACE

METHOD_DEFAULT_METHOD_ADDED_TO_INTERFACE

public static final Code METHOD_DEFAULT_METHOD_ADDED_TO_INTERFACE

METHOD_STATIC_METHOD_ADDED_TO_INTERFACE

public static final Code METHOD_STATIC_METHOD_ADDED_TO_INTERFACE

METHOD_ATTRIBUTE_WITH_NO_DEFAULT_ADDED_TO_ANNOTATION_TYPE

public static final Code METHOD_ATTRIBUTE_WITH_NO_DEFAULT_ADDED_TO_ANNOTATION_TYPE

METHOD_ATTRIBUTE_WITH_DEFAULT_ADDED_TO_ANNOTATION_TYPE

public static final Code METHOD_ATTRIBUTE_WITH_DEFAULT_ADDED_TO_ANNOTATION_TYPE

METHOD_ABSTRACT_METHOD_ADDED

public static final Code METHOD_ABSTRACT_METHOD_ADDED

METHOD_ADDED

public static final Code METHOD_ADDED

METHOD_FINAL_METHOD_ADDED_TO_NON_FINAL_CLASS

public static final Code METHOD_FINAL_METHOD_ADDED_TO_NON_FINAL_CLASS

METHOD_REMOVED

public static final Code METHOD_REMOVED

METHOD_MOVED_TO_SUPERCLASS

public static final Code METHOD_MOVED_TO_SUPERCLASS

METHOD_INHERITED_METHOD_MOVED_TO_CLASS

public static final Code METHOD_INHERITED_METHOD_MOVED_TO_CLASS

METHOD_ATTRIBUTE_REMOVED_FROM_ANNOTATION_TYPE

public static final Code METHOD_ATTRIBUTE_REMOVED_FROM_ANNOTATION_TYPE

METHOD_NO_LONGER_FINAL

public static final Code METHOD_NO_LONGER_FINAL

METHOD_NOW_FINAL

public static final Code METHOD_NOW_FINAL

METHOD_NOW_FINAL_IN_FINAL_CLASS

public static final Code METHOD_NOW_FINAL_IN_FINAL_CLASS

METHOD_VISIBILITY_INCREASED

public static final Code METHOD_VISIBILITY_INCREASED

METHOD_VISIBILITY_REDUCED

public static final Code METHOD_VISIBILITY_REDUCED

METHOD_RETURN_TYPE_CHANGED

public static final Code METHOD_RETURN_TYPE_CHANGED

METHOD_RETURN_TYPE_TYPE_PARAMETERS_CHANGED

public static final Code METHOD_RETURN_TYPE_TYPE_PARAMETERS_CHANGED

METHOD_RETURN_TYPE_CHANGED_COVARIANTLY

public static final Code METHOD_RETURN_TYPE_CHANGED_COVARIANTLY

METHOD_NUMBER_OF_PARAMETERS_CHANGED

public static final Code METHOD_NUMBER_OF_PARAMETERS_CHANGED

METHOD_PARAMETER_TYPE_CHANGED

public static final Code METHOD_PARAMETER_TYPE_CHANGED

METHOD_PARAMETER_TYPE_PARAMETER_CHANGED

public static final Code METHOD_PARAMETER_TYPE_PARAMETER_CHANGED

METHOD_NO_LONGER_STATIC

public static final Code METHOD_NO_LONGER_STATIC

METHOD_NOW_STATIC

public static final Code METHOD_NOW_STATIC

METHOD_CHECKED_EXCEPTION_ADDED

public static final Code METHOD_CHECKED_EXCEPTION_ADDED

METHOD_RUNTIME_EXCEPTION_ADDED

public static final Code METHOD_RUNTIME_EXCEPTION_ADDED

METHOD_CHECKED_EXCEPTION_REMOVED

public static final Code METHOD_CHECKED_EXCEPTION_REMOVED

METHOD_RUNTIME_EXCEPTION_REMOVED

public static final Code METHOD_RUNTIME_EXCEPTION_REMOVED

METHOD_NO_LONGER_DEFAULT

public static final Code METHOD_NO_LONGER_DEFAULT

METHOD_NOW_DEFAULT

public static final Code METHOD_NOW_DEFAULT

METHOD_NOW_ABSTRACT

public static final Code METHOD_NOW_ABSTRACT

METHOD_NO_LONGER_ABSTRACT

public static final Code METHOD_NO_LONGER_ABSTRACT

GENERICS_ELEMENT_NOW_PARAMETERIZED

public static final Code GENERICS_ELEMENT_NOW_PARAMETERIZED

GENERICS_FORMAL_TYPE_PARAMETER_ADDED

public static final Code GENERICS_FORMAL_TYPE_PARAMETER_ADDED

GENERICS_FORMAL_TYPE_PARAMETER_REMOVED

public static final Code GENERICS_FORMAL_TYPE_PARAMETER_REMOVED

GENERICS_FORMAL_TYPE_PARAMETER_CHANGED

public static final Code GENERICS_FORMAL_TYPE_PARAMETER_CHANGED

METHOD_RETURN_TYPE_ERASURE_CHANGED

public static final Code METHOD_RETURN_TYPE_ERASURE_CHANGED

METHOD_PARAMETER_TYPE_ERASURE_CHANGED

public static final Code METHOD_PARAMETER_TYPE_ERASURE_CHANGED

Method Detail

values

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

Returns:

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

valueOf

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

fromCode

public static Code fromCode(String code)

attachmentsFor

public static <T extends JavaElement> LinkedHashMap<String,String> attachmentsFor(@Nullable
                                                                                        T oldElement,
                                                                                        @Nullable
                                                                                        T newElement,
                                                                                        String... customAttachments)

code

public String code()

createDifference

public org.revapi.Difference createDifference(@Nonnull
                                              Locale locale)

createDifference

public org.revapi.Difference createDifference(@Nonnull
                                              Locale locale,
                                              LinkedHashMap<String,String> attachments)

createDifference

public org.revapi.Difference createDifference(@Nonnull
                                              Locale locale,
                                              LinkedHashMap<String,String> attachments,
                                              String... parameters)