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

fix: consolidate a consistent behavior for CtElement#getParent #3793

Merged
merged 10 commits into from
Feb 24, 2021
Merged

fix: consolidate a consistent behavior for CtElement#getParent #3793

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ff82f1a
doc: sync CtElement#getParent(Filter) javadoc with actual behavior
sibwaf Dec 24, 2020
a5ab091
fix: sync getParent(Class) overload behavior on parent == null
sibwaf Dec 29, 2020
1b625e1
fix: sync getParent(Filter) overload behavior on no matching parent
sibwaf Feb 11, 2021
94f7fca
test: Check CtElement#getParent consistency
sibwaf Feb 11, 2021
2f16fa3
fix: Fix improper codestyle
sibwaf Feb 15, 2021
8b6e119
Empty commit to restart CI
sibwaf Feb 16, 2021
fc1fdad
fix: Remove exception from getParent(Class) and getParent(Filter)
sibwaf Feb 19, 2021
503ddc7
refactor: Move element parent tests to ParentTest
sibwaf Feb 19, 2021
7233465
doc: Add info about null returns for CtElement#getParent
sibwaf Feb 22, 2021
5fb4fb6
doc: Reword @return clause for CtElement#getParent
Feb 22, 2021
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
4 changes: 4 additions & 0 deletions src/main/java/spoon/reflect/declaration/CtElement.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,11 +249,15 @@ <E extends CtElement> List<E> getAnnotatedChildren(

/**
* Gets the first parent that matches the given type.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you document this with an @return, in particular that it returns null if there's no match?

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is based on the discussion we had previously about the poor documentation of null returns in Spoon :)

*
* @return null when a matching parent was not found or this element doesn't have a parent
sibwaf marked this conversation as resolved.
Show resolved Hide resolved
*/
<P extends CtElement> P getParent(Class<P> parentType);

/**
* Gets the first parent that matches the filter.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same as above.

*
* @return null when a matching parent was not found or this element doesn't have a parent
sibwaf marked this conversation as resolved.
Show resolved Hide resolved
*/
<E extends CtElement> E getParent(Filter<E> filter);

Expand Down