Editing 1188: Bonding
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 10: | Line 10: | ||
This is {{w|source code}} written in the {{w|Java (programming language)|Java programming language}} which models a parent and a child playing a {{w|Catch (game)|game of catch}}. Normally this game is played with the parent throwing a ball to their child, who catches it and throws it back, and repeated back-and-forth. The comic title "Bonding" refers to the {{w|Paternal bond|building of relationship}} between the parent and the child. The joke lies in the puns using the words <code>try</code>, <code>throw</code>, <code>catch</code>, and <code>Throwable</code>. These can refer to actions in the real-life game, but are also keywords in the Java language that are used for {{w|exception handling}}, a method of signaling error conditions and responding to them. Also, the terms "parent" and "child" are usually interpreted more abstractly in programming, as generic terms used in hierarchical {{w|Data structure|data structures}}. | This is {{w|source code}} written in the {{w|Java (programming language)|Java programming language}} which models a parent and a child playing a {{w|Catch (game)|game of catch}}. Normally this game is played with the parent throwing a ball to their child, who catches it and throws it back, and repeated back-and-forth. The comic title "Bonding" refers to the {{w|Paternal bond|building of relationship}} between the parent and the child. The joke lies in the puns using the words <code>try</code>, <code>throw</code>, <code>catch</code>, and <code>Throwable</code>. These can refer to actions in the real-life game, but are also keywords in the Java language that are used for {{w|exception handling}}, a method of signaling error conditions and responding to them. Also, the terms "parent" and "child" are usually interpreted more abstractly in programming, as generic terms used in hierarchical {{w|Data structure|data structures}}. | ||
− | The program, as written, will {{w|Recursion (computer science)|recursively}} call the <code>aim</code> method alternately on the parent and the child indefinitely, causing each to take turns throwing and catching the <code>Ball</code> object. Note that unlike the real game, this program actually has the same person both throwing and catch the same ball on their turn. The ball is passed onto the other person by ''aiming'' it at them, which causes the person to both throw and catch the ball, and ''aim'' it back | + | The program, as written, will {{w|Recursion (computer science)|recursively}} call the <code>aim</code> method alternately on the parent and the child indefinitely, causing each to take turns throwing and catching the <code>Ball</code> object. Note that unlike the real game, this program actually has the same person both throwing and catch the same ball on their turn. The ball is passed onto the other person by ''aiming'' it at them, which causes the person to both throw and catch the ball, and ''aim'' it back. This program will also eventually crash with a {{w|stack overflow}} error. |
− | The title text refers to the [http://www.eclipse.org/ Eclipse IDE], which is a tool commonly used to develop software in Java. "Building character" is something that you would expect a parent to do, in order to instill in his child positive traits, such as confidence and athleticism. This is possibly a reference to | + | The title text refers to the [http://www.eclipse.org/ Eclipse IDE], which is a tool commonly used to develop software in Java. "Building character" is something that you would expect a parent to do, in order to instill in his child positive traits, such as confidence and athleticism. This is possibly a reference to Calvin and Hobbes, where Calvin's dad often encourages him to build character in a number of ways, including playing baseball. This is made more likely by other references combining technology and C+H, such as xkcd comics 409, 702, and 1002. However, here, "build" might also be a play on the term of "{{w|Software build|building}}" a program, while "{{w|Character_(computing)|character}}" refers to a data type in programming languages. It may also refer to the common notion that programming in C++ or Java builds character due to their powerful but sometimes finicky libraries. |
===Program description=== | ===Program description=== | ||
Line 19: | Line 19: | ||
#The Ball class [http://docs.oracle.com/javase/tutorial/java/IandI/subclasses.html extends] [http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html Throwable], making it possible to use an instance of Ball in [http://docs.oracle.com/javase/tutorial/essential/exceptions/handling.html exception handling]. In English, this means "a Ball is a kind of Throwable object". | #The Ball class [http://docs.oracle.com/javase/tutorial/java/IandI/subclasses.html extends] [http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html Throwable], making it possible to use an instance of Ball in [http://docs.oracle.com/javase/tutorial/essential/exceptions/handling.html exception handling]. In English, this means "a Ball is a kind of Throwable object". | ||
#The P class, representing a Person, which contains the following members (attributes): | #The P class, representing a Person, which contains the following members (attributes): | ||
− | + | :*a [http://docs.oracle.com/javase/tutorial/java/javaOO/variables.html class variable] 'target' to point to another P to aim a Ball at. | |
− | + | :*a [http://docs.oracle.com/javase/tutorial/java/javaOO/constructors.html constructor] 'P' (in Java the constructor always has the same name as the class) used to create an instance of P and initialize its state (with a target). The keyword [http://docs.oracle.com/javase/tutorial/java/javaOO/thiskey.html this] refers to the current instance of P. | |
− | + | :*a [http://docs.oracle.com/javase/tutorial/java/javaOO/methods.html method] 'aim' that takes an instance of Ball named 'ball' as a parameter. This contains the code to actually throw, catch, and pass the ball onto the target. | |
− | + | :*a [http://docs.oracle.com/javase/tutorial/java/javaOO/classvars.html static] method 'main' which is called when executing this class. This is the code that starts the whole process. | |
The program executes in the following order: | The program executes in the following order: | ||
Line 28: | Line 28: | ||
##An instance of P named 'parent' is created without a target ({{w|Nullable_type|null}}) using the 'new' keyword. | ##An instance of P named 'parent' is created without a target ({{w|Nullable_type|null}}) using the 'new' keyword. | ||
##Another instance of P named 'child' is created with 'parent' as its target. | ##Another instance of P named 'child' is created with 'parent' as its target. | ||
− | ##The parent's target is assigned to be the child. | + | ##The parent's target is assigned to be the child. |
− | + | ##An instance of Ball is created and passed as a parameter to the aim method of parent. | |
− | #The aim method first sets up a [http://docs.oracle.com/javase/tutorial/essential/exceptions/try.html try] block to handle exceptions | + | #The aim method first sets up a [http://docs.oracle.com/javase/tutorial/essential/exceptions/try.html try] block to handle exceptions. |
− | #Next, the Ball instance 'ball' is [http://docs.oracle.com/javase/tutorial/essential/exceptions/throwing.html thrown]. This signals an exception situation | + | #Next, the Ball instance 'ball' is [http://docs.oracle.com/javase/tutorial/essential/exceptions/throwing.html thrown]. This signals an exception situation. |
− | #In the catch block | + | #The thrown exception (= the Ball instance) is handled in the [http://docs.oracle.com/javase/tutorial/essential/exceptions/catch.html catch] block with the matching exception class. |
− | #The | + | #In the catch block the aim method of the target of the P instance is called with the Ball instance (now referred to as 'b'). |
+ | #The code continues with step 6, but the current class instance ('this') has changed from parent to child (or vice versa). | ||
+ | |||
+ | While compact and suitable for this comic, the code style can be improved if this were a real programming project: | ||
+ | #Good Java code should contain documentation in the form of {{w|Javadoc}} comments. | ||
+ | #It is recommended to organize Java source code into [http://docs.oracle.com/javase/tutorial/java/package/packages.html packages] to make code easier to find and use and to avoid name conflicts. | ||
+ | #The class interface should not expose inner logic and data. For this reason class variables are usually declared as [http://docs.oracle.com/javase/tutorial/java/javaOO/accesscontrol.html private] (or protected) and separate public methods (called getters and setters) are created to access the data. Making target private would also require using the setTarget setter method in main to set the parent target to child. | ||
+ | #In most cases constructors should call their superclass constructor first. P descents from Object, which has an empty constructor, so this is not strictly required here. | ||
+ | #The aim method references the class variable target directly. To avoid future name conflicts it is recommended to prefix the reference to target with 'this' or use the getter from #3. | ||
+ | #A <code>try</code> block that does nothing except <code>throw</code> is redundant. In this comic it is needed to make the code more readable as English sentences, but in programming this pattern should be avoided. | ||
==Transcript== | ==Transcript== |