Class JApiClass

java.lang.Object

japicmp.model.JApiClass

All Implemented Interfaces:

JApiCanBeSynthetic, JApiCompatibility, JApiHasAbstractModifier, JApiHasAccessModifier, JApiHasAnnotations, JApiHasChangeStatus, JApiHasFinalModifier, JApiHasModifiers, JApiHasStaticModifier, JApiHasSyntheticAttribute, JApiHasSyntheticModifier, JApiJavaObjectSerializationCompatibility

public class JApiClass
extends Object
implements JApiHasModifiers, JApiHasChangeStatus, JApiHasAccessModifier, JApiHasStaticModifier, JApiHasFinalModifier, JApiHasAbstractModifier, JApiCompatibility, JApiHasAnnotations, JApiJavaObjectSerializationCompatibility, JApiCanBeSynthetic

Nested Class Summary

Nested classes/interfaces inherited from interface JApiJavaObjectSerializationCompatibility

JApiJavaObjectSerializationCompatibility.JApiJavaObjectSerializationChangeStatus

Field Summary

Fields

Modifier and Type	Field	Description
private final JApiModifier<AbstractModifier>	abstractModifier
private final JApiModifier<AccessModifier>	accessModifier
private final List<JApiAnnotation>	annotations
private boolean	changeCausedByClassElement
private final JApiChangeStatus	changeStatus
private final JApiClassFileFormatVersion	classFileFormatVersion
private final JApiClassType	classType
private final List<JApiCompatibilityChange>	compatibilityChanges
private final List<JApiConstructor>	constructors
private final List<JApiField>	fields
private final JApiModifier<FinalModifier>	finalModifier
private final String	fullyQualifiedName
private final List<JApiImplementedInterface>	interfaces
private JApiJavaObjectSerializationCompatibility.JApiJavaObjectSerializationChangeStatus	jApiJavaObjectSerializationChangeStatus
private final JApiSerialVersionUid	jApiSerialVersionUid
private final JarArchiveComparator	jarArchiveComparator
private final List<JApiMethod>	methods
private final Optional<javassist.CtClass>	newClass
private final Optional<javassist.CtClass>	oldClass
private final JarArchiveComparatorOptions	options
private final JApiModifier<StaticModifier>	staticModifier
private final JApiSuperclass	superclass
private final JApiAttribute<SyntheticAttribute>	syntheticAttribute
private final JApiModifier<SyntheticModifier>	syntheticModifier

Constructor Summary

Constructors

Constructor	Description
JApiClass(JarArchiveComparator jarArchiveComparator, String fullyQualifiedName, Optional<javassist.CtClass> oldClass, Optional<javassist.CtClass> newClass, JApiChangeStatus changeStatus, JApiClassType classType)

Method Summary

Modifier and Type	Method	Description
private void	addParametersToMethod(MethodDescriptorParser methodDescriptorParser, JApiBehavior jApiMethod)
private Map<String, javassist.CtField>	buildFieldMap(javassist.CtClass ctClass)
private void	buildInterfaceMap(JarArchiveComparator.ArchiveType archiveType, Map<String, javassist.CtClass> map, javassist.CtClass ctInterface)
private Map<String, javassist.CtClass>	buildInterfaceMap(javassist.CtClass ctClass, JarArchiveComparator.ArchiveType archiveType)
private void	buildInterfaceMap(javassist.CtClass ctClass, JarArchiveComparator.ArchiveType archiveType, Map<String, javassist.CtClass> map)
private void	computeAnnotationChanges(List<JApiAnnotation> annotations, Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private void	computeFieldChanges(List<JApiField> fields, Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private void	computeInterfaceChanges(List<JApiImplementedInterface> interfacesArg, Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private void	computeMethodChanges(JApiClass jApiClass, Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private Map<String, javassist.CtConstructor>	createConstructorMap(Optional<javassist.CtClass> ctClass)
private Map<String, List<javassist.CtMethod>>	createMethodMap(Optional<javassist.CtClass> ctClassOptional)
private JApiChangeStatus	evaluateChangeStatus(JApiChangeStatus changeStatus)
private JApiModifier<AbstractModifier>	extractAbstractModifier(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private JApiModifier<AccessModifier>	extractAccessModifier(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private JApiClassFileFormatVersion	extractClassFileFormatVersion(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private JApiModifier<FinalModifier>	extractFinalModifier(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private JApiModifier<StaticModifier>	extractStaticModifier(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private JApiSuperclass	extractSuperclass(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private JApiAttribute<SyntheticAttribute>	extractSyntheticAttribute(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private JApiModifier<SyntheticModifier>	extractSyntheticModifier(Optional<javassist.CtClass> oldClassOptional, Optional<javassist.CtClass> newClassOptional)
private Optional<javassist.CtMethod>	findMatchingMethod(javassist.CtMethod method, List<javassist.CtMethod> candidates)
JApiModifier<AbstractModifier>	getAbstractModifier()	Returns the abstract modifier.
JApiModifier<AccessModifier>	getAccessModifier()	Returns the access modifier.
List<JApiAnnotation>	getAnnotations()	Returns a list of annotations as JApiAnnotation.
List<JApiAttribute<? extends Enum<?>>>	getAttributes()
JApiChangeStatus	getChangeStatus()	Returns the change status of this element.
JApiClassFileFormatVersion	getClassFileFormatVersion()
JApiClassType	getClassType()
List<JApiCompatibilityChange>	getCompatibilityChanges()	Returns all compatibility changes.
List<JApiConstructor>	getConstructors()
List<JApiField>	getFields()
JApiModifier<FinalModifier>	getFinalModifier()	Returns the final modifier.
String	getFullyQualifiedName()
List<JApiImplementedInterface>	getInterfaces()
JApiJavaObjectSerializationCompatibility.JApiJavaObjectSerializationChangeStatus	getJavaObjectSerializationCompatible()	Returns if this class is serializable and if it has changed in a compatible or incompatible way.
String	getJavaObjectSerializationCompatibleAsString()
List<JApiMethod>	getMethods()
List<? extends JApiModifier<? extends Enum<? extends Enum<?>>>>	getModifiers()	Returns a list of modifiers.
Optional<javassist.CtClass>	getNewClass()
Optional<javassist.CtClass>	getOldClass()
JApiSerialVersionUid	getSerialVersionUid()	Returns the JApiSerialVersionUid
JApiModifier<StaticModifier>	getStaticModifier()	Returns the static modifier.
JApiSuperclass	getSuperclass()
private Optional<javassist.CtClass>	getSuperclass(javassist.CtClass ctClass)
JApiAttribute<SyntheticAttribute>	getSyntheticAttribute()
JApiModifier<SyntheticModifier>	getSyntheticModifier()	Returns the synthetic modifier.
private boolean	includeConstructor(JApiConstructor jApiConstructor)
private boolean	includeField(JApiField jApiField)
private boolean	includeMethod(JApiMethod jApiMethod)
boolean	isBinaryCompatible()	Returns true if this element has changed binary compatible.
boolean	isChangeCausedByClassElement()
boolean	isSourceCompatible()	Returns true if this element has changed source compatible.
(package private) void	setJavaObjectSerializationCompatible(JApiJavaObjectSerializationCompatibility.JApiJavaObjectSerializationChangeStatus jApiJavaObjectSerializationChangeStatus)
private void	sortConstructorsIntoLists(JApiClass jApiClass, Map<String, javassist.CtConstructor> oldConstructorsMap, Map<String, javassist.CtConstructor> newConstructorsMap)
private void	sortMethodsIntoLists(JApiClass jApiClass, Map<String, List<javassist.CtMethod>> oldMethodsMap, Map<String, List<javassist.CtMethod>> newMethodsMap)
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

jarArchiveComparator

private final JarArchiveComparator jarArchiveComparator

fullyQualifiedName

private final String fullyQualifiedName

classType

private final JApiClassType classType

options

private final JarArchiveComparatorOptions options

oldClass

private final Optional<javassist.CtClass> oldClass

newClass

private final Optional<javassist.CtClass> newClass

changeStatus

private final JApiChangeStatus changeStatus

superclass

private final JApiSuperclass superclass

interfaces

private final List<JApiImplementedInterface> interfaces

fields

private final List<JApiField> fields

constructors

private final List<JApiConstructor> constructors

methods

private final List<JApiMethod> methods

annotations

private final List<JApiAnnotation> annotations

accessModifier

private final JApiModifier<AccessModifier> accessModifier

finalModifier

private final JApiModifier<FinalModifier> finalModifier

staticModifier

private final JApiModifier<StaticModifier> staticModifier

abstractModifier

private final JApiModifier<AbstractModifier> abstractModifier

syntheticModifier

private final JApiModifier<SyntheticModifier> syntheticModifier

syntheticAttribute

private final JApiAttribute<SyntheticAttribute> syntheticAttribute

compatibilityChanges

private final List<JApiCompatibilityChange> compatibilityChanges

jApiSerialVersionUid

private final JApiSerialVersionUid jApiSerialVersionUid

classFileFormatVersion

private final JApiClassFileFormatVersion classFileFormatVersion

changeCausedByClassElement

private boolean changeCausedByClassElement

jApiJavaObjectSerializationChangeStatus

private JApiJavaObjectSerializationCompatibility.JApiJavaObjectSerializationChangeStatus jApiJavaObjectSerializationChangeStatus

Constructor Details

JApiClass

public JApiClass(JarArchiveComparator jarArchiveComparator,
 String fullyQualifiedName,
 Optional<javassist.CtClass> oldClass,
 Optional<javassist.CtClass> newClass,
 JApiChangeStatus changeStatus,
 JApiClassType classType)

Method Details

extractClassFileFormatVersion

private JApiClassFileFormatVersion extractClassFileFormatVersion(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

computeAnnotationChanges

private void computeAnnotationChanges(List<JApiAnnotation> annotations,
 Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

extractSyntheticAttribute

private JApiAttribute<SyntheticAttribute> extractSyntheticAttribute(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

computeFieldChanges

private void computeFieldChanges(List<JApiField> fields,
 Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

includeField

private boolean includeField(JApiField jApiField)

buildFieldMap

private Map<String, javassist.CtField> buildFieldMap(javassist.CtClass ctClass)

extractSuperclass

private JApiSuperclass extractSuperclass(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

getSuperclass

private Optional<javassist.CtClass> getSuperclass(javassist.CtClass ctClass)

computeInterfaceChanges

private void computeInterfaceChanges(List<JApiImplementedInterface> interfacesArg,
 Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

buildInterfaceMap

private Map<String, javassist.CtClass> buildInterfaceMap(javassist.CtClass ctClass,
 JarArchiveComparator.ArchiveType archiveType)

buildInterfaceMap

private void buildInterfaceMap(javassist.CtClass ctClass,
 JarArchiveComparator.ArchiveType archiveType,
 Map<String, javassist.CtClass> map)

buildInterfaceMap

private void buildInterfaceMap(JarArchiveComparator.ArchiveType archiveType,
 Map<String, javassist.CtClass> map,
 javassist.CtClass ctInterface)
                        throws javassist.NotFoundException

Throws:

javassist.NotFoundException

computeMethodChanges

private void computeMethodChanges(JApiClass jApiClass,
 Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

sortMethodsIntoLists

private void sortMethodsIntoLists(JApiClass jApiClass,
 Map<String, List<javassist.CtMethod>> oldMethodsMap,
 Map<String, List<javassist.CtMethod>> newMethodsMap)

findMatchingMethod

private Optional<javassist.CtMethod> findMatchingMethod(javassist.CtMethod method,
 List<javassist.CtMethod> candidates)

includeMethod

private boolean includeMethod(JApiMethod jApiMethod)

sortConstructorsIntoLists

private void sortConstructorsIntoLists(JApiClass jApiClass,
 Map<String, javassist.CtConstructor> oldConstructorsMap,
 Map<String, javassist.CtConstructor> newConstructorsMap)

includeConstructor

private boolean includeConstructor(JApiConstructor jApiConstructor)

addParametersToMethod

private void addParametersToMethod(MethodDescriptorParser methodDescriptorParser,
 JApiBehavior jApiMethod)

createMethodMap

private Map<String, List<javassist.CtMethod>> createMethodMap(Optional<javassist.CtClass> ctClassOptional)

createConstructorMap

private Map<String, javassist.CtConstructor> createConstructorMap(Optional<javassist.CtClass> ctClass)

evaluateChangeStatus

private JApiChangeStatus evaluateChangeStatus(JApiChangeStatus changeStatus)

extractStaticModifier

private JApiModifier<StaticModifier> extractStaticModifier(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

extractFinalModifier

private JApiModifier<FinalModifier> extractFinalModifier(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

extractAccessModifier

private JApiModifier<AccessModifier> extractAccessModifier(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

extractAbstractModifier

private JApiModifier<AbstractModifier> extractAbstractModifier(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

extractSyntheticModifier

private JApiModifier<SyntheticModifier> extractSyntheticModifier(Optional<javassist.CtClass> oldClassOptional,
 Optional<javassist.CtClass> newClassOptional)

getJavaObjectSerializationCompatible

public JApiJavaObjectSerializationCompatibility.JApiJavaObjectSerializationChangeStatus getJavaObjectSerializationCompatible()

Description copied from interface: JApiJavaObjectSerializationCompatibility

Returns if this class is serializable and if it has changed in a compatible or incompatible way.

Specified by:

getJavaObjectSerializationCompatible in interface JApiJavaObjectSerializationCompatibility

Returns:

the type of change

getJavaObjectSerializationCompatibleAsString

public String getJavaObjectSerializationCompatibleAsString()

getSerialVersionUid

public JApiSerialVersionUid getSerialVersionUid()

Description copied from interface: JApiJavaObjectSerializationCompatibility

Returns the JApiSerialVersionUid

Specified by:

getSerialVersionUid in interface JApiJavaObjectSerializationCompatibility

Returns:

the serialVersionUID

setJavaObjectSerializationCompatible

void setJavaObjectSerializationCompatible(JApiJavaObjectSerializationCompatibility.JApiJavaObjectSerializationChangeStatus jApiJavaObjectSerializationChangeStatus)

getChangeStatus

public JApiChangeStatus getChangeStatus()

Description copied from interface: JApiHasChangeStatus

Returns the change status of this element.

Specified by:

getChangeStatus in interface JApiHasChangeStatus

Returns:

the change status of this element

getFullyQualifiedName

public String getFullyQualifiedName()

getNewClass

public Optional<javassist.CtClass> getNewClass()

getOldClass

public Optional<javassist.CtClass> getOldClass()

getModifiers

public List<? extends JApiModifier<? extends Enum<? extends Enum<?>>>> getModifiers()

Description copied from interface: JApiHasModifiers

Returns a list of modifiers.

Specified by:

getModifiers in interface JApiHasModifiers

Returns:

a list of modifiers

getSuperclass

public JApiSuperclass getSuperclass()

getInterfaces

public List<JApiImplementedInterface> getInterfaces()

getConstructors

public List<JApiConstructor> getConstructors()

getMethods

public List<JApiMethod> getMethods()

getFields

public List<JApiField> getFields()

getClassType

public JApiClassType getClassType()

getFinalModifier

public JApiModifier<FinalModifier> getFinalModifier()

Description copied from interface: JApiHasFinalModifier

Returns the final modifier.

Specified by:

getFinalModifier in interface JApiHasFinalModifier

Returns:

the final modifier

getStaticModifier

public JApiModifier<StaticModifier> getStaticModifier()

Description copied from interface: JApiHasStaticModifier

Returns the static modifier.

Specified by:

getStaticModifier in interface JApiHasStaticModifier

Returns:

the static modifier

getAccessModifier

public JApiModifier<AccessModifier> getAccessModifier()

Description copied from interface: JApiHasAccessModifier

Returns the access modifier.

Specified by:

getAccessModifier in interface JApiHasAccessModifier

Returns:

the access modifier

getAbstractModifier

public JApiModifier<AbstractModifier> getAbstractModifier()

Description copied from interface: JApiHasAbstractModifier

Returns the abstract modifier.

Specified by:

getAbstractModifier in interface JApiHasAbstractModifier

Returns:

the abstract modifier

getSyntheticModifier

public JApiModifier<SyntheticModifier> getSyntheticModifier()

Description copied from interface: JApiHasSyntheticModifier

Returns the synthetic modifier.

Specified by:

getSyntheticModifier in interface JApiHasSyntheticModifier

Returns:

the synthetic modifier

getSyntheticAttribute

public JApiAttribute<SyntheticAttribute> getSyntheticAttribute()

Specified by:

getSyntheticAttribute in interface JApiHasSyntheticAttribute

getAttributes

public List<JApiAttribute<? extends Enum<?>>> getAttributes()

isBinaryCompatible

public boolean isBinaryCompatible()

Description copied from interface: JApiCompatibility

Returns true if this element has changed binary compatible.

Specified by:

isBinaryCompatible in interface JApiCompatibility

Returns:

true if this element has changed binary compatible

isSourceCompatible

public boolean isSourceCompatible()

Description copied from interface: JApiCompatibility

Returns true if this element has changed source compatible.

Specified by:

isSourceCompatible in interface JApiCompatibility

Returns:

true if this element has changed source compatible

getAnnotations

public List<JApiAnnotation> getAnnotations()

Description copied from interface: JApiHasAnnotations

Returns a list of annotations as JApiAnnotation.

Specified by:

getAnnotations in interface JApiHasAnnotations

Returns:

a list of annotations as JApiAnnotation

isChangeCausedByClassElement

public boolean isChangeCausedByClassElement()

getCompatibilityChanges

public List<JApiCompatibilityChange> getCompatibilityChanges()

Description copied from interface: JApiCompatibility

Returns all compatibility changes.

Specified by:

getCompatibilityChanges in interface JApiCompatibility

Returns:

a list of compatibility changes

getClassFileFormatVersion

public JApiClassFileFormatVersion getClassFileFormatVersion()

toString

public String toString()

Overrides:

toString in class Object