Sofware Construction for HSE: Frequently Asked Questons

Fall/Winter 2013-2014

General

• What to do if I missed a deadline?
• What to do if my submission was rejected?
• What to do if I want to retry an assignment?
• What to do if I do not understand something?
• What is an easy way to stay up to date with the course downloads?
• What are 2IP15 and 2IPC0?

NetBeans

• Which version of NetBeans should I use?
• How do I use the 2IP15 PrePostDoclet in NetBeans?
• How do I use the 2IP15 Checkstyle configuration file in NetBeans?
• How do I generate javadoc for a NetBeans project with the source files in a default package?
• How do I enable runtime assertion checking in NetBeans?
• NetBeans behaves strangely (e.g., incorrect error messages); what now?
• How can I disable the spellchecker in NetBeans?

DrJava

• How do I use the 2IP15 PrePostDoclet in DrJava?
• How can I use JUnit 4 with DrJava?

Java

• Which version of Java should I use?
• What is the story behind final parameters?
• Why is my package-info.java ignored by javadoc, and how can I fix this?

peach³

• How do I use peach³?
• What if I cannot register for this course?
• Why do my JUnit test cases not work in peach³?

Answers

General

What to do if I missed a deadline?

When you think you will not be able to meet a deadline, then you can submit a timely and motivated request for a deadline extension. Send your request to the lecturer

In such a request, always include

1. Your name and group number
2. Which assignment(s) it concerns
3. Your motivation
4. Suggested date/time for extended deadline

If the deadline has already expired, then you need to submit your request as soon as possible. Explain in the motivation also why the request comes so late.

What to do if my submission was rejected?

A rejected submission does not count, and it needs to be corrected. Proceed as with a missed deadline (because you did not fulfil the requirements within the deadline). Mention as motivation that you want to correct a rejected submission, and explain why you think it was rejected.

Do this immediatly after seeing the rejection and do not delay this.

What to do if I want to retry an assignment?

If you are not satisfied with the result of an assignment and you think you can do better, then you can request a retry.

Proceed as with a missed deadline. Mention as motivation that you want to improve the result for the assignment, and explain what the nature of this improvement will be.

Note that not all requests for retries will be honored. Furthermore, for graded assignments, there will be an automatic deduction, and the requirements will possibly be checked more strictly.

What to do if I do not understand something?

If you do not understand something, then you can consult

• one of the books (Burris, Eck),
• the slides of the lectures,
• other study material,
• another student.

If that does not resolve your questions, then

for practical questions concerning tools or the Java language

consult one of the HSE assistants,

for technical questions concerning the subject matter

consult ??? your instructor (possibly by email);

for logistical questions concerning organization and procedures

consult ....

What is an easy way to stay up to date with the course downloads?

The course website and included downloads (except for material with restricted access) are also available in a Subversion repository. This repository has public read access.

• Address of repository for access with a web browser: https://svn.win.tue.nl/viewvc/SC-HSE-2014-2015-student-material
• Address of repository for access with a Subversion client: https://svn.win.tue.nl/repos/SC-HSE-2014-2015-student-material

Suggested way of using it:

1. Get yourself a Subversion client.
   • Most Linux distributions and Mac OS X come with a command-line Subversion client.
   • For Windows, you can download TurtoiseSVN.
2. Check out the entire repository, using the address above for Subversion clients.
   You need to do that only once.
3. Do not edit files in this checked out copy.
   If you want to use a downloaded file, copy it from the checked out copy of the site to the location with your own work.
4. To obtain the latest changes from the repository, update your checked out copy, using your Subversion client.
   You can also
   • get the update status, to find out whether there are updates available in the repository,
   • view log messages that summarize the changes, and
   • obtain a diff (line-by-line differences) to see change details per file.

What are 2IP15 and 2IPC0?

2IP15 and 2IPC0 are the (old and new) codes for Programming Methods, a second-year CS course at TU/e. We borrow material from that course, so you will sometimes see that identifier.

NetBeans

Which version of NetBeans should I use?

We use NetBeans 8.0 That is, NetBeans projects that we make available will have been made with NetBeans 7.2 or later.

There can be problems when opening such a project with an older version of NetBeans. If you make a project with an older version of NetBeans, then we often can process it (but there is no guarantee). If you use a newer version, then possibly we cannot open it, and cannot provide assistance or evaluate it.

If everyone uses the save version of NetBeans, then it is easier for us to address issues.

How do I use the 2IP15 PrePostDoclet in NetBeans?

1. Download PrePostDoclet.jar.
2. Store it in an easily accessible place.
3. For each project, configure its properties:
   • Project Properties > Build > Documenting
   • Check @author and @version
   • Fill in Additional Javadoc Options:

     -docletpath dp -doclet nl.tue.doclets.PrePostDoclet

     where dp is the absolute path to the jar-file (including PrePostDoclet.jar).
     If that path contains spaces, then put quotes around the path.

How do I use the 2IPC0 Checkstyle configuration file in NetBeans?

The following instructions are subject to change!
1. Add the SQE Update Center:
   • Tools > Plugins > Settings
   • Click Add and fill in
   • Name: SQE Update Center
   • URL: http://deadlock.netbeans.org/hudson/job/sqe/lastStableBuild/artifact/build/full-sqe-updatecenter/updates.xml
   • Click OK
2. Install and activate Checkstyle:
   • Tools > Plugins > Available Plugins
   • Select Checkstyle.
     Feel free to install the other Quality plugins (PMD, FindBugs, and DependencyFinder) as well, but be warned that they are rather picky.
   • Click Install
3. Configure Checkstyle:
   • Download checkstyle-2ip15.xml
   • Store it in an easily accessible place.
   • Tools > Options (MacOS: NetBeans > Preferences)
   • Quality > Checkstyle
   • Set the Config File to the downloaded checkstyle-2ip15.xml
   • Properties File remains empty, as well as Properties.
   • Click OK
4. Apply Checkstyle to test it:
   • Right-click on your project, and select Quality > CodeDefects > Run Checkstyle
   • In the bottom pane, below the source code editor, select the Checkstyle tab to see the Checkstyle audit output.
   • Try some bad indentation to see how that is reported...

How do I generate javadoc for a NetBeans project with the source files in a default package?

You need to repair a configuration file. This screencast explains how to do it. Here is a summary.

1. When you try to generate javadoc for a NetBeans project that has its source files in the default package, you get an error message like this:

       /.../nbproject/build-impl.xml:1195: No source files and no packages have been specified.
       BUILD FAILED (total time: 0 seconds)
   

2. Click the URL for build-impl.xml , and that file will open in the editor at a line with a <javadoc ...> tag.
3. Within that tag, four lines, down you see:

       <fileset dir="${src.dir}" excludes="*.java,${excludes}" includes="${includes}">
   

4. Delete *.java, (including the comma), yielding

       <fileset dir="${src.dir}" excludes="${excludes}" includes="${includes}">
   

5. Save the file, and try again.

How do I enable runtime assertion checking in NetBeans?

• Project Properties > Run
• Arguments: -ea

NetBeans behaves strangely (e.g., incorrect error messages); what now?

NetBeans stores some information about projects in a cache. This cache is not cleared by restarting NetBeans or restarting the operating system.

If information in the cache is inconsistent or corrupted, then NetBeans can be very persistent in giving incorrect error messages (e.g. Duplicate class or Class not found).

You can manually clear the cache.

How can I disable the spellchecker in NetBeans?

You can try:

Go to Tools > Plugins > Installed tab > Select the Spellchecker plugin > Press Deactivate > Restart NetBeans

Alternatively, you can disable it for certain file types only:

Windows (and Linux?):

Tools > Options > Miscellaneous > Spellchecker > uncheck (e.g.) Javadoc comments > OK

Mac:

NetBeans > Preferences > Miscellaneous > Spellchecker > uncheck (e.g.) Javadoc comments > OK

DrJava

How do I use the 2IP15 PrePostDoclet in DrJava?

1. Download PrePostDoclet.jar.
2. Store it in an easily accessible place.
3. Configure the preferences:
   • Edit > Preferences > Javadoc
   • Custom Javadoc Parameters:

     -author -version -docletpath dp -doclet nl.tue.doclets.PrePostDoclet

     where dp is the absolute path to the jar-file (including PrePostDoclet.jar).
     If that path contains spaces, then put quotes around the path.

How can I use JUnit 4 with DrJava?

1. Locate a copy of junit-4.10.jar on your machine.
   NetBeans probably installed a copy of it somewhere.
   If you cannot find it, then you can download it from here and store it in an easily accessible place.
2. Open the Preferences of DrJava.
3. Below Extra Classpath, click on Add, and select junit-4.10.jar.
4. Click OK.
5. Open the Xxx.java and XxxTest.java files for testing.
6. Compile them.
7. In the Interactions pane, type: run org.junit.runner.JUnitCore XxxTest
8. The interactions pane will show the JUnit output and then reset (output is deleted).
9. Click the Console tab to see the JUnit output.

Java

Which version of Java should I use?

We use Java 7. However, most of the language constructs that appear in this course are available in Java 5.

What is the story behind final parameters?

The modifier final on a parameter in the header of a method definition concerns only the implementation, not the specification. That is why you will not see final in extracted javadoc.

For the implementation, it means that the method body cannot change this parameter (the compiler will enforce that). This offers several advantages:

• The compiler can generate more efficient code.
• It protects against some mistakes that otherwise might be difficult to find; e.g. when such a parameter is accidentally assigned a value.
• There are situations where it is required; e.g. when using the parameter inside an anonymous local class.

N.B. If the parameter concerns a reference (to an object), then the method body cannot make this parameter refer to another object. However, when the object is mutable, the method body can change the object's state!

Why is my package-info.java ignored by javadoc, and how can I fix this?

It is a known limitation that package-info.java in an otherwise empty package is not processed by javadoc. It is not unreasonable to have such package directories, especially at the top level.

Workaround: Include a dummy class to make javadoc notice the package documentation and process it:

package ...;

/**  
 * Exists only to enable package-info.java to be processed by javadoc.
 */
class Dummy {
}

By making it package-private, this dummy class itself will not show up in the javadoc output, unless you specify the private or package option in javadoc.

PEACH³

How do I use peach³?

Currently, there is no on-line user documentation for the new peach³ web interface. The peach³ FAQ for students explains how to accomplish some common tasks.

What if I cannot register for this course?

You need to register for this course via peach³.

In case of further problems, contact the lecturer.

System failures can be reported to E.T.J.Scheffers@tue.nl.

Why do my JUnit test cases not work in peach³?

Two common reasons are:

• You are not using the right version of JUnit.
  In this course, we use JUnit 4.10 and not JUnit 3.8.x.
• You have included package statements in your soure files. Currently, peach³ cannot handle source files in packages.