japicmp.model.JApiCompatibilityChangeType Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of japicmp Show documentation
japicmp is a library that computes the differences between two versions of a jar file/artifact in order to ease the API documentation for clients/customers.
There is a newer version: 0.23.1
Show newest version
package japicmp.model;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlEnum;
import java.util.Arrays;
import java.util.Comparator;

@XmlEnum
public enum JApiCompatibilityChangeType {
	ANNOTATION_ADDED(true, true, JApiSemanticVersionLevel.PATCH),
	ANNOTATION_DEPRECATED_ADDED(true, true, JApiSemanticVersionLevel.MINOR),
	ANNOTATION_MODIFIED(true, true, JApiSemanticVersionLevel.PATCH),
	ANNOTATION_REMOVED(true, true, JApiSemanticVersionLevel.PATCH),
	CLASS_REMOVED(false, false, JApiSemanticVersionLevel.MAJOR),
	CLASS_NOW_ABSTRACT(false, false, JApiSemanticVersionLevel.MAJOR),
	CLASS_NOW_FINAL(false, false, JApiSemanticVersionLevel.MAJOR),
	CLASS_NO_LONGER_PUBLIC(false, false, JApiSemanticVersionLevel.MAJOR),
	CLASS_TYPE_CHANGED(false, false, JApiSemanticVersionLevel.MAJOR),
	CLASS_NOW_CHECKED_EXCEPTION(true, false, JApiSemanticVersionLevel.MINOR),
	CLASS_LESS_ACCESSIBLE(false, false, JApiSemanticVersionLevel.MAJOR),
	CLASS_GENERIC_TEMPLATE_CHANGED(true, false, JApiSemanticVersionLevel.MINOR),
	CLASS_GENERIC_TEMPLATE_GENERICS_CHANGED(true, false, JApiSemanticVersionLevel.MINOR),
	SUPERCLASS_REMOVED(false, false, JApiSemanticVersionLevel.MAJOR),
	SUPERCLASS_ADDED(true, true, JApiSemanticVersionLevel.MINOR),
	SUPERCLASS_MODIFIED_INCOMPATIBLE(false, false, JApiSemanticVersionLevel.MAJOR),
	INTERFACE_ADDED(true, true, JApiSemanticVersionLevel.MINOR),
	INTERFACE_REMOVED(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_REMOVED(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_REMOVED_IN_SUPERCLASS(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_LESS_ACCESSIBLE(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_LESS_ACCESSIBLE_THAN_IN_SUPERCLASS(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_IS_STATIC_AND_OVERRIDES_NOT_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_RETURN_TYPE_CHANGED(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_RETURN_TYPE_GENERICS_CHANGED(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_PARAMETER_GENERICS_CHANGED(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_NOW_ABSTRACT(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_NOW_FINAL(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_NOW_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_NO_LONGER_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_NOW_VARARGS(true, true, JApiSemanticVersionLevel.MINOR),
	METHOD_NO_LONGER_VARARGS(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_ADDED_TO_INTERFACE(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_ADDED_TO_PUBLIC_CLASS(true, true, JApiSemanticVersionLevel.PATCH),
	METHOD_NOW_THROWS_CHECKED_EXCEPTION(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_NO_LONGER_THROWS_CHECKED_EXCEPTION(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_ABSTRACT_ADDED_TO_CLASS(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_ABSTRACT_ADDED_IN_SUPERCLASS(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_ABSTRACT_ADDED_IN_IMPLEMENTED_INTERFACE(true, false, JApiSemanticVersionLevel.MINOR),
	METHOD_DEFAULT_ADDED_IN_IMPLEMENTED_INTERFACE(true, true, JApiSemanticVersionLevel.MINOR),
	METHOD_NEW_DEFAULT(true, true, JApiSemanticVersionLevel.MINOR),
	METHOD_NEW_STATIC_ADDED_TO_INTERFACE(true, true, JApiSemanticVersionLevel.MINOR),
	METHOD_MOVED_TO_SUPERCLASS(true, true, JApiSemanticVersionLevel.PATCH),
	METHOD_ABSTRACT_NOW_DEFAULT(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_NON_STATIC_IN_INTERFACE_NOW_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	METHOD_STATIC_IN_INTERFACE_NO_LONGER_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_STATIC_AND_OVERRIDES_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_LESS_ACCESSIBLE_THAN_IN_SUPERCLASS(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_NOW_FINAL(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_NOW_TRANSIENT(true, true, JApiSemanticVersionLevel.PATCH),
	FIELD_NOW_VOLATILE(true, true, JApiSemanticVersionLevel.PATCH),
	FIELD_NOW_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_NO_LONGER_TRANSIENT(true, true, JApiSemanticVersionLevel.PATCH),
	FIELD_NO_LONGER_VOLATILE(true, true, JApiSemanticVersionLevel.PATCH),
	FIELD_NO_LONGER_STATIC(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_TYPE_CHANGED(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_REMOVED(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_REMOVED_IN_SUPERCLASS(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_LESS_ACCESSIBLE(false, false, JApiSemanticVersionLevel.MAJOR),
	FIELD_GENERICS_CHANGED(true, false, JApiSemanticVersionLevel.MINOR),
	CONSTRUCTOR_REMOVED(false, false, JApiSemanticVersionLevel.MAJOR),
	CONSTRUCTOR_LESS_ACCESSIBLE(false, false, JApiSemanticVersionLevel.MAJOR);

	private final boolean binaryCompatible;
	private final boolean sourceCompatible;
	private final JApiSemanticVersionLevel semanticVersionLevel;
	private Boolean binaryCompatibleOverridden = null;
	private Boolean sourceCompatibleOverridden = null;
	private JApiSemanticVersionLevel semanticVersionLevelOverridden = null;

	JApiCompatibilityChangeType(boolean binaryCompatible, boolean sourceCompatible,
								JApiSemanticVersionLevel jApiSemanticVersionLevel) {
		this.binaryCompatible = binaryCompatible;
		this.sourceCompatible = sourceCompatible;
		this.semanticVersionLevel = jApiSemanticVersionLevel;
	}

	@XmlAttribute(name = "binaryCompatible")
	public boolean isBinaryCompatible() {
		if (binaryCompatibleOverridden != null) {
			return binaryCompatibleOverridden;
		}
		return binaryCompatible;
	}

	@XmlAttribute(name = "sourceCompatible")
	public boolean isSourceCompatible() {
		if (sourceCompatibleOverridden != null) {
			return sourceCompatibleOverridden;
		}
		return sourceCompatible;
	}

	public JApiSemanticVersionLevel getSemanticVersionLevel() {
		if (semanticVersionLevelOverridden != null) {
			return semanticVersionLevelOverridden;
		}
		return semanticVersionLevel;
	}

	public void setBinaryCompatible(boolean binaryCompatible) {
		this.binaryCompatibleOverridden = binaryCompatible;
	}

	public void setSourceCompatible(boolean sourceCompatible) {
		this.sourceCompatibleOverridden = sourceCompatible;
	}

	public void setSemanticVersionLevel(JApiSemanticVersionLevel semanticVersionLevel) {
		this.semanticVersionLevelOverridden = semanticVersionLevel;
	}

	public void resetOverrides() {
		this.binaryCompatibleOverridden = null;
		this.sourceCompatibleOverridden = null;
		this.semanticVersionLevelOverridden = null;
	}

	public static void main(String[] args) {
		StringBuilder sb = new StringBuilder();
		sb.append("| Check | Default binary compatible | Default source compatible | Default semantic version level |\n");
		sb.append("|-------|---------------------------|---------------------------|--------------------------------|\n");
		JApiCompatibilityChangeType[] values = Arrays.copyOf(JApiCompatibilityChangeType.values(), JApiCompatibilityChangeType.values().length);
		Arrays.sort(values, Comparator.comparing(Enum::name));
		for (JApiCompatibilityChangeType type : values) {
			sb.append("| ").append(type.name())
				.append(" | ").append(type.binaryCompatible)
				.append(" | ").append(type.sourceCompatible)
				.append(" | ").append(type.semanticVersionLevel.name())
				.append(" |\n");
		}
		System.out.println(sb);
	}
}