Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc:explicit the difference between isOverriding and isSubsignature #1449

Merged
merged 3 commits into from
Jun 29, 2017
Merged

doc:explicit the difference between isOverriding and isSubsignature #1449

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
881bca4
Propose some changes to explicit the difference between isOverriding …
surli Jun 29, 2017
578b61d
Improve doc
surli Jun 29, 2017
8f4c0e6
Slight change
surli Jun 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions src/main/java/spoon/support/visitor/ClassTypingContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,8 +301,13 @@ public <T> CtMethod<T> adaptMethod(CtMethod<T> method) {
}

/**
* isOverriding is defined as a relation between two methods
* where one is the subsignature of the other. There is no order in this relation.
* See https://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.4.2
*
* @param thisMethod - the scope method
* @param thatMethod - to be checked method
* @return true if scope method overrides `thatMethod`
* @return true if thisMethod overrides thatMethod or the contrary
*/
public boolean isOverriding(CtMethod<?> thisMethod, CtMethod<?> thatMethod) {
if (thisMethod == thatMethod) {
Expand All @@ -318,26 +323,32 @@ public boolean isOverriding(CtMethod<?> thisMethod, CtMethod<?> thatMethod) {
}
}
//TODO check method visibility following https://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.4.8.1
return isSubSignature(thisMethod, thatMethod);
return isSubSignature(thisMethod, thatMethod) || isSubSignature(thatMethod, thisMethod);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not that, because in our case we can be sure that thisMethod belongs to sub class and thatMethod belongs to super class. So origin code is OK

}

/**
* scope method is subsignature of thatMethod if either
* A) scope method is same signature like thatMethod
* B) scope method is same signature like type erasure of thatMethod
* isSubsignature is defined as an oriented relation between two methods as defined in
* See https://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.4.2
*
* thisMethod is subsignature of thatMethod if either
* A) thisMethod is same signature like thatMethod
* B) thisMethod is same signature like type erasure of thatMethod
*
* @param thisMethod - the scope method to be checked with
* @param thatMethod - the checked method
* @return true if scope method is subsignature of thatMethod
* @return true if thisMethod is subsignature of thatMethod
*/
public boolean isSubSignature(CtMethod<?> thisMethod, CtMethod<?> thatMethod) {
return isSameSignature(thisMethod, thatMethod, true);
}

/**
* The same signature is the necessary condition for method A overrides method B.
* Two methods are considered as having the same signature if they have the same name and argument types
* See https://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.4.2
*
* @param thisExecutable - the scope method to be checked with
* @param thatExecutable - the checked method
* @return true if this method and `thatMethod` has same signature
* @return true if this method and thatMethod has same signature
*/
public boolean isSameSignature(CtExecutable<?> thisExecutable, CtMethod<?> thatExecutable) {
if ((thatExecutable instanceof CtMethod || thatExecutable instanceof CtConstructor) == false) {
Expand Down