Home > Articles

  • Print
  • + Share This
This chapter is from the book


When Sun mentions deliverables, it is referring to the actual files you must submit with your project, described in the following list:

  • Full source and object code, including new classes, modified versions of supplied classes, and copies of supplied classes that were not modified. The source files and class files should be in an appropriate directory structure along with the class files. You can use JAR files to contain groups of elements of your project as you deem appropriate—for example, elements needed to support the running of your programs.

  • The database.bin database file, which is the same one supplied with the assignment download.

  • Full documentation, including the following:

    • You must provide HTML/javadoc documentation for all classes, whether supplied, modified, or new. Make sure you comment your code thoroughly, and then this documentation is easy to generate.

    • You must provide user documentation for the database server and the GUI client. Most people provide the GUI documentation as a Web page. It can be packaged with your project or available online (be sure to provide the correct URL).

    • You must provide a README.TXT file that tells the evaluator how to use your application. This file must be in the root directory of your project.

    • You must provide a document called DESIGN_CHOICES.TXT that explains how you tackled the assignment's two major issues. You need to convince the evaluator that you know what you are doing, not that your approach is the best one. The two major design choices are whether you chose RMI or Serialized objects, and whether you chose to modify or extending the supplied Data class.

  • All your project elements must be packaged into a single JAR file for submission. Nesting JAR files inside the main JAR is permitted.


The README.TXT file must be in plain ASCII format. I recommend providing the DESIGN_CHOICES.TXT file in ASCII format also, although the evaluator will accept it in Microsoft Word format.

Your entire project must be uploaded as one JAR file. Don't try any other method of packaging your project, or the evaluator might fail you for not following this simple instruction. Evaluators aren't amused if they receive projects requiring them to unzip, untar, unlock, decrypt, or unravel your submitted ball of files.

Source Code Files

The biggest part of your grade is the source code. The first thing the evaluator does is read the README.TXT file to figure out how to test the application to make sure it works. If it doesn't work or those instructions cause a mistake, you automatically fail the assignment. The evaluator then reads your DESIGN_CHOICES.TXT document to learn how you designed the application and reads through your code.

Your project submission has to include all the class files so that the application runs, but it must also include all the source files used in your application's final build. This includes the Sun-supplied files (if you modified a class file, include the modified version) and the ones you added. Although the evaluator won't actually build your application from the source code, he should be able to. If you modified one of Sun's supplied files, don't include both the original and the modified file; just include the modified one.

The directory structure is another source of confusion. I've seen mostly simple and reasonable structures, but also some unnecessarily complicated ones. My project submission had only four directories (suncerity.client, suncerity.server, suncerity.db, and javadoc), but your directory structure is determined by how you package the classes. Don't be ingenious; just be practical. If you need more than four directories, it could raise a red flag for the evaluator. It might indicate that you can't organize your classes and perhaps your solution is overengineered. There is no magic number of directories, but if you have more than four, I recommend rethinking the structure so that it is more compact.

The database.bin Database File

Sun supplies a binary database file named database.bin that you must return with the rest of your project submission. You can place this file anywhere you like, as long as the application can find it. I recommend placing it in the root directory to make the file access code simpler. If you put the database.bin file somewhere else, just make sure the pathing parameters to the file access code are right: Use / for Unix and let the software take care of translating to a backslash on Windows. My application determined the delimiter at runtime, so the delimiter character didn't matter in my case. Whatever your approach, just be sure you don't make the mistake of writing code that can find the file in one place on your system, but can't find the same file on the evaluator's machine because you packaged it differently.


Four documentation pieces should be in the JAR file: the README.TXT file, the DESIGN_CHOICES.TXT document, the full javadoc set, and a user help Web page. In your javadoc documentation, be sure to use the special comment tags—starting with /** and ending with */—in your source code so that the javadoc program can process the code to produce HTML-formatted documentation. Creating javadoc comments is part of the assignment, so make sure you use regular javadoc conventions.


Depending on your design, the number of files javadoc generates vary. In my case, I had 100 javadoc files. If your application is clean, you should have about 10 source files. Certainly, you can add lots of functionality, resulting in 20 source files and several hundred javadoc files. However, you will lose points with this approach. Instead, strive to design an elegant and clean application that meets the requirements. Be warned: Adding functionality that doesn't satisfy a specific requirement is inviting trouble. Doing so raises questions about your ability to follow simple instructions, and the extra functionality could introduce errors that cost you points.

User Help

Another document you need to supply is the user help file, which should be a Web page. You can include it in the JAR file or simply hard-code the URL in the client to the Web page hosted somewhere else on the Internet; there are merits to both methods. The local file is faster and just as easy to include as it is to include the README.TXT file. The online reference method means there is one fewer file to include in the JAR file. You can assume that the evaluator has access to the Internet.


The user help document should be a Web page. It can be included in your project submission or hosted on a Web site, in which case the client should be able to view it from a menu.


Neglecting to provide user help costs points that are so easy to earn. Also, don't rely on users viewing help with their favorite browsers. You should provide a window (for example, a JTextPane in a JScrollPane) for it.


As mentioned in Chapter 1, "Certification Steps and Submission Grading," you must create a README.TXT file and a DESIGN_CHOICES.TXT document. Chapter 5, "Documentation and Javadoc Comments," provides a thorough explanation and an example of both files.

Deprecated Classes and Other Items

In the transition from Java 1 to the current SDK 1.4, the libraries have changed. In some cases, the signatures remained the same, but in other cases, they have changed. These revisions to the standard library resulted in some classes, variables, and methods becoming outdated. Sun keeps these outdated items in the library to support older programs, but refers to them as deprecated. Deprecated methods should not be used in new code, but Sun did sneak a few into the assignment intentionally to see what you would do about them. They aren't hard to fix, and every time you compile the classes they are in, you see the deprecated message. Also, the javadoc API documentation provides a convenient listing of deprecated items and marks them in the class documentation.

You can modify these deprecated methods or override them in a subclass. I chose the latter approach and justified it in the DESIGN_CHOICES.TXT document by arguing that the legacy code would still work in previous uses, and the new subclass isolates the changes for better maintenance going forward. Either approach is fine, but you have to justify your choice.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020