Functional Specification

Purpose

The purpose of this report is to provide a specification and technical knowledge required to write introductory instructions for JBuilder 2006.

Scope

This guide will include: Creating new projects Creating new applications Running projects Debugging Editing with JBuilder 2006 editor enhancements Refactoring

Requirements

A user will need a PC running Windows XP. Pentium IV 1 GHz or faster with 1.5 Gigabytes of memory and a free 750MB of free disk space.

Processes

Setting up a new project: there is a New Project Wizard accessible from the Object Gallery or directly off the File menu. Wizards: The new project wizard is used first. New Application wizard is used next.

Adding components to the new frame: A frame was created when the new application wizard was run. Edit project. Editing a project is where programmers spend most of their time. There are numerous editing features within JBuilder, code introspection tools like member insight, code insight, and parameter insight, navigation tools like find definition and find reference, automatic code formatting, code templates, search and replace with regular expression sysntax, syntax highlighting, and syncedit. Running or debugging a project. R

Refactor project: is Making a project: Java files need to be compiled before theyre run. The build system consists of a compiler, and optionally the ANT wizard and the Archive Builder Wizard. These optional tools allow a build to be designed to be run via the command line.

Troubleshooting

Vista: JBuilder will not install on Microsoft Vista. Solution: install JBuilder on an XP machine and copy the directory structure to your Vista machine. Note that it is unnecessary to register JBuilder before copying the directories.

Glossary

Debugging: Running a program step by step while watching variables, threads, or other pertinent information so that errors or unintentional consequences of the code can be seen and fixed. .java file: The java programming language is compiled. Java files are compiled into .class files. Package: .java files exist within a hierarchy analogous, and often synonymous to the directory structure on your computer. Jar file: A jar file is a file structure, usually a set of packages compressed into a single file. Java programs are usually delivered as Jar files. Method: Typically portions of a class file with input and output. A method typically takes Class: when a .java file is compiled a class file is created Refactoring: Systematically changing all references to a .java file, a method Editing: Adding, removing or altering the contents of a program file, in this case a .java file are all considered aspects of editing. JDK: Java Development Kit Parameter: a parameter is a accepted by a method as the input value.

Introduction
JBuilder is a programming development environment from Borland, a company that came to prominence in the early 1990s as a competitor to Microsoft. Programming development environments are usually called IDEs, a three letter acronym for integrated development environment.

Before 1984 programmers used a separate editor, debugger and compiler. Then in 1984 Borland introduced Turbo Pascal, which integrated the compiler, debugger and compiler into one product. Since then things have changed a little, more and more things have been integrated into the major IDEs. A modern IDE has support not just for compiling, editing and debugging but also for refactoring, collaboration, using version control systems.

Edit Pane Project Pane

Structure Pane Message Pane

Code folding: In the Edit Pane, Blue triangles appear next to the right hand gutter. Each triangle folds and unfolds a block of text. From the menu all items can be folded or unfolded at once ( Edit |Code Folding | Fold All) Finding and Replacing Code Bookmarks: when programmers are developing software they often have a half dozen or more files open at the same time.. it can be challenging in this environment to track the relevant code in all those files. Its almost impossible to remember where the relevant code is after leaving for a night or weekend. CodeInsight: Code insight is a term used in JBuilder for the coding assistance tools built into the editor.

Memberinsight: shows the available classes, variables and components available from the current class context (shown as the title for the scroll box). Typing ahead will reduce the view of the available components to just the components that start with the letters typed. The up/down cursors or mouse can be used to select a method or the first few letters can be typed in to navigate to a component. When the desired component is reached the enter key will add it to your current cursor position in your java class.

Parameter Insight: shows what types of parameters a method will take. If we use templates within a method, first create a method from the Right Click menu, under the Add item there is an Add Method to <name of current class>. Just click OK when the dialog pops up. Within the curly braces of the method type in out then Ctrl + J to complete a template for a system out function. You now have the context to see parameter insight. Move your cursor inside the parenthesis and use the Ctrl + Shift + space combination of keys, or place your cursor between the parenthesis and wait a moment. A pop up dialog with the appropriate ClassInsight: There is so much to remember when programming that programmers can use as much assistance as possible. If a programmer can remember the first few letters of a class they want to use they can hold down the control and alt keys then hit space to bring up a tool that will look through the current projects classpath to find matching classes, hopefully this will refresh the programmers memory. A programmer can also add a reference to the class in the class currently being edited, along

with an import statement for that class.

Javadoc and commenting code: there are two different ways to comment java code. When code has been commented it will no longer be compilable unless it is uncommented. The first is to add a // before a line, or the remainder of a line of code. JBuilder offers a shortcut for this in the editor, you can select multiple lines and use the / key while holding down the ctrl key. The second type of code commenting is to comment all code between an /* and a */. This second type of comment has two shortcuts, one is to begin a line with /** then hit the return key, the other is to use code template tool after typing jdc. To use javadoc from code that your using, the shortcut is Ctrl + Q, this will bring up a modal dialog that shows the help for the class or method that

youre using.

Code Templates: Control + J activates code templates. They can also be used by typing the short description, for instance tryc to insert a try/catch block of code.

SyncEditMode: any time a block of text is highlit in the editor an icon with a scroll shows up Ctrl+Shift+J

Refactoring: the rubics cube icon will commit a refactoring after the message pane shows the refactoring. Distributed Refactoring: its common for APIs to be shared between departments and even companies. When packages, class names and methods change and are released in updated APIs the changes can break

code that uses them. Team refactoring works to store a description of each refactoring, the description can be used to automate the changes in the new code.

Project Groups: large projects are often broken up into smaller pieces so that dependencies can be more easily managed and so that developers have an understandable codebase to work from. If you think you might want to have a project become a set of projects it is helpful to keep the code from those projects in separate directories. Javadoc: is a standard way to embed documentation into code. JBuilder has a javadoc wizard that copies these comments out and puts them in a directory of the users choosing.