'. '

Default Listener Methods

From APIDesign

(Difference between revisions)
Jump to: navigation, search
Current revision (06:45, 19 April 2018) (edit) (undo)
 
(14 intermediate revisions not shown.)
Line 1: Line 1:
-
Recently I tried to apply the [[DefaultMethods]] [[API Design]] warning to work done by my colleagues and they (obviously) objected. That's OK, that happens all the time, but the worst thing this time was: they were right!
+
Recently I tried to apply the [[DefaultMethods]] [[API Design]] warning to work done by my colleagues and they (obviously) objected. That's OK, they object all the time, but the worst thing this time was: they were right!
-
Do you remember the classical [[JavaBean]] pattern called ''listener'' and its associated ''adapter''? Imagine for example {{JDK|java/awt/event|MouseListener}} and {{JDK|java/awt/event|MouseAdapter}}. The pair of classes was created to save users from always implementing all the ''listener'' methods and rather use the adapter. Turns out [[DefaultMethods]] allow us to merge these two types into one:
+
=== [[JavaBean]] Listener and Adapter ===
 +
 
 +
Do you remember the classical [[JavaBean]] pattern called ''listener'' and its associated ''adapter''? Imagine for example {{JDK|java/awt/event|MouseListener}} and {{JDK|java/awt/event|MouseAdapter}}. The pair of types used to be created to save users from always implementing all the ''listener'' methods and offer them to save some typing by rather using the adapter. Turns out [[DefaultMethods]] allow us to merge these two types into one:
<source lang="java">
<source lang="java">
Line 13: Line 15:
</source>
</source>
-
Such listener type is both a ''listener'' as well as an ''adaptor'' and there is nothing wrong with that!
+
Such listener type is both a ''listener'' as well as an ''adaptor'' and there is nothing wrong with that!
-
== Why? ==
+
=== Why? ===
-
Why does the [[DefaultMethods|philippic]] against using [[DefaultMethods]] in an [[API]] doesn't apply? The code that runs after one of the listener methods isn't (unless an unexpected [[exception]] happens) influenced by the code in the method - e.g. it shouldn't matter what the method does and thus adding new method with default empty implementation seems to be OK. The necessary condition for that is the fact that the methods return '''void''' - if they returned anything observable - e.g. the default body would something like:
+
Why does the [[DefaultMethods|philippic]] against using [[DefaultMethods]] in an [[API]] doesn't apply? The code that runs after one of the listener methods isn't (unless an unexpected [[exception]] happens or unless it never returns or runs too long - e.g. all the usual warnings when calling foreign code are applicable) influenced by the code in the method - e.g. it shouldn't matter what the method does and thus adding new method with default empty implementation seems to be OK.
 +
 
 +
There is a necessary condition for that: such methods have to return '''void'''. If the methods returned anything observable, then we'd be back in the [[DefaultMethods]] situation. If the default body would look like this:
<source lang="java">
<source lang="java">
-
/** @return true to "consume" the event */
+
/** @return true to "consume" the event */
-
public default boolean mouseExited(MouseEvent e) {
+
public default boolean mouseExited(MouseEvent e) {
-
return false;
+
return false;
-
}
+
}
</source>
</source>
-
then all the above arguments against these methods would apply again, as it would be impossible to distinguish between methods having default implementation or methods overridden with intention to keep the default implementation.
+
then [[DefaultMethods|all the arguments]] against using these [[DefaultMethods]] would apply again. It would again be impossible to distinguish between methods having default implementation or [[DefaultMethods]] overridden with intention to keep the default implementation.
-
== Up Side Down ==
+
=== Up Side Down ===
Thanks Dušane for pointing the ''listener'' case out! As mentioned in [[TheAPIBook]], slight change in the initial situation may turn the final advice up side down. Thus I gladly (have to) admit: using [[DefaultMethods]] in listener [[JavaBean]] pattern is perfectly fine.
Thanks Dušane for pointing the ''listener'' case out! As mentioned in [[TheAPIBook]], slight change in the initial situation may turn the final advice up side down. Thus I gladly (have to) admit: using [[DefaultMethods]] in listener [[JavaBean]] pattern is perfectly fine.
-
[[Category:APIDesignPatterns:Anti]] [[Category:APIDesignPatterns:Clarity]] [[Category:APIDesignPatterns:Evolution]]
+
[[Category:APIDesignPatterns]] [[Category:APIDesignPatterns:Clarity]] [[Category:APIDesignPatterns:Evolution]]

Current revision

Recently I tried to apply the DefaultMethods API Design warning to work done by my colleagues and they (obviously) objected. That's OK, they object all the time, but the worst thing this time was: they were right!

JavaBean Listener and Adapter

Do you remember the classical JavaBean pattern called listener and its associated adapter? Imagine for example MouseListener and MouseAdapter. The pair of types used to be created to save users from always implementing all the listener methods and offer them to save some typing by rather using the adapter. Turns out DefaultMethods allow us to merge these two types into one:

public interface MouseListener extends EventListener {
    public default void mouseClicked(MouseEvent e) {}
    public default void mousePressed(MouseEvent e) {}
    public default void mouseReleased(MouseEvent e) {}
    public default void mouseEntered(MouseEvent e) {}
    public default void mouseExited(MouseEvent e) {}
}

Such listener type is both a listener as well as an adaptor and there is nothing wrong with that!

Why?

Why does the philippic against using DefaultMethods in an API doesn't apply? The code that runs after one of the listener methods isn't (unless an unexpected exception happens or unless it never returns or runs too long - e.g. all the usual warnings when calling foreign code are applicable) influenced by the code in the method - e.g. it shouldn't matter what the method does and thus adding new method with default empty implementation seems to be OK.

There is a necessary condition for that: such methods have to return void. If the methods returned anything observable, then we'd be back in the DefaultMethods situation. If the default body would look like this:

/** @return true to "consume" the event */
public default boolean mouseExited(MouseEvent e) {
    return false;
}

then all the arguments against using these DefaultMethods would apply again. It would again be impossible to distinguish between methods having default implementation or DefaultMethods overridden with intention to keep the default implementation.

Up Side Down

Thanks Dušane for pointing the listener case out! As mentioned in TheAPIBook, slight change in the initial situation may turn the final advice up side down. Thus I gladly (have to) admit: using DefaultMethods in listener JavaBean pattern is perfectly fine.

Personal tools