1.7. Writing Code

Now that your first Java project has created and you have explored different ways to navigate the system and find the items needed, it is time to start using Eclipse tools to write new code. Eclipse supports a number of different editor types, both internal and external, for editing types of resources. Double-clicking on a Java file, for example, opens the Java editor (see Figure 1-37).

1.7.1. Java editor

The Java editor provides many features that focus on the job of editing Java code, including the following:

• Colored syntax highlighting (see Figure 1-37)

• User-defined code formatting

• Import organization and correction

• Context-sensitive code assistance

• "Quick fix" automatic problem correction

1.7.1.1. Colored syntax highlighting

The colored syntax highlighting feature controls how Java code will be depicted. Independent control over color and font style (plain or bold) is provided for multi- and single-line comments, keywords, strings, characters, task tags, and Javadoc elements via the Java > Editor > Syntax Coloring preference page (see Figure 1-38).

Figure 1-38. Syntax Coloring preference page.

[View full size image]

1.7.1.2. User-defined code formatting

The code formatting feature controls how Java code will be formatted any time the Source > Format command is issued. A variety of options are provided for controlling brace position, new lines, line length, and white space usage through use of the Java > Code Style > Formatter preference page (see Figure 1-39).

Figure 1-39. Code Formatter preference page.

[View full size image]

1.7.1.3. Organizing Java import statements

The import organization feature provides an easy way to clean up the import statements within a Java file. New imports can be added using the Source > Add Import command, and existing imports can be cleaned up using the Source > Organize Imports command. The Java > Code Style > Organize Imports preference page (see Figure 1-40) provides a means to set the default order of import statements and the threshold above which wildcard imports will be used.

Figure 1-40. Organize Imports preference page.

[View full size image]

1.7.1.4. Context-sensitive code assist

The context-sensitive code assist feature can help speed up the creation of Java code quite dramatically. It can complete class names, method names, parameter names, and more. In Eclipse 3.2, CamelCase patterns, such as NPE, will expand to full class names such as NullPointerException.

To use it, position the cursor at a location in your Java code needing a suggestion and select either the Edit > Content Assist command or hold the Ctrl key down while pressing the Space key. This opens the popup code assist window (see Figure 1-41).

Figure 1-41. Code assistance in action.

[View full size image]

The Java > Editor > Code Assist (Content Assist under Eclipse 3.2) preference page (see Figure 1-42) provides a number of options to control how the code assist feature acts when invoked.

Figure 1-42. Code Assist preference page.

[View full size image]

1.7.1.5. "Quick fix" automatic problem correction

The "quick fix" feature provides a way to easily fix common problems within the Java editor. Any time a problem is detected that can be fixed, a lightbulb icon is displayed in the marker bar (left vertical ruler) of the editor. Clicking on the icon opens a popup quick fix window (see Figure 1-43). Selecting the appropriate one from the list applies that fix to the Java source.

Dozens of built-in quick fixes are available, including:

• Correcting missing or incorrect package declarations

• Removing unused and duplicate imports

• Changing the visibility of types, methods, and fields

• Renaming types, methods, and fields

• Removing unused private types, methods, and fields

• Creating new types, methods, and fields

• Fixing incorrect method arguments

• Adding or removing catch blocks

• Adding necessary cast operations

1.7.2. Templates

Templates are common source code patterns that appear frequently in user-written code. Eclipse has dozens of built-in templates and new ones are very easy to add.

To use a template, position the cursor at the desired position in your Java code, start to type the name of the template, and press Ctrl+Space. This opens the popup content assist window (see Figure 1-44). Note that some templates are parameterized with user-defined variables. Once a template has been expanded, use the Tab key to move between variables.

As an example, open the HelloWorld class that was created in Section 1.4.4, Using the Java Class wizard, on page 24 then enter "sysout" and press Ctrl+Space. This expands the sysout template to System.out.println(); with the cursor placed between the two parentheses. Type "Hello World" and press Ctrl+S to save your changes. This application will be run in Section 1.9, Running Applications, on page 54.

The Java > Editor > Templates preference page (see Figure 1-45) provides a place to add new templates and edit existing ones.

Figure 1-45. Templates preference page.

[View full size image]

To add a new template, click the New button to open the Edit Template dialog (see Figure 1-46). Enter the name for the pattern in the Name field, its description in the Description field, and the code pattern itself in the Pattern field (note that code assist is not case-sensitive).

Figure 1-46. Edit Template dialog.

[View full size image]

Eclipse supports two types of patterns, Java and Javadoc. Select the pattern type from the Context drop-down list. The Insert Variable button pops up a list of variables that can be inserted into the template. Click the OK button to add the template to the template list.

1.7.3. Refactoring

Refactoring is the process of changing a software system to improve its internal structure and reusability, without altering the external behavior of the program. It is a disciplined way of cleaning up code that minimizes the chances of introducing bugs. In essence, when developers refactor, they are improving the design of the code. Eclipse provides a very powerful and comprehensive collection of refactoring tools that make refactoring operations quick, easy, and reliable.

The Eclipse refactoring commands are available either from the Java editor's context menu or from the Refactor menu that is available from the main menu bar anytime a Java editor is open. The Refactor menu (see Figure 1-47) includes more than a dozen different refactoring commands that modify some aspect of a Java element and then update any references to it elsewhere in the workspace.

The refactoring commands that are supported include the following:

• RenameRenames a Java element.

• MoveMoves a Java element.

• Change Method SignatureChanges method parameters (names, types, and order).

• Convert Anonymous Class to NestedConverts an anonymous inner class to a named nested class.

• Move Member Type to New FileConverts a nested type into a top-level type.

• Push DownMoves fields and methods from a class to one of its subclasses.

• Pull UpMoves fields, methods, or member types from a class to one of its superclasses.

• Extract InterfaceCreates a new interface from a collection of selected methods.

• Generalize TypeGeneralizes the type of variable declarations, parameters, fields, and method return types.

• Use Supertype Where PossibleReplaces a type with one of its supertypes anywhere that transformation is possible.

• Infer Generic Type ArgumentsAttempts to infer type parameters for all generic type references in a class, package, or project. This is especially useful when migrating from Java 1.4 code to Java 5.0 code.

• InlineInlines methods, constants, and local variables.

• Extract MethodCreates a new method based on the selected text in the current method and updates the current method to call the new method.

• Extract Local VariableCreates a new local variable assigned to the selected expression and replaces the selection with a reference to the new variable.

• Extract ConstantCreates a static final field from the selected expression.

• Introduce ParameterReplaces an expression with a parameter reference.

• Introduce FactoryReplaces a constructor invocation with a call to a new factory method.

• Convert Local Variable to FieldConverts a local variable into a field.

• Encapsulate FieldReplaces all direct references to a field with references to the field's getter and setter methods and creates those methods as necessary.

To use any refactoring command, select the Java element or expression that you would like to refactor and then select the refactoring command. Each refactoring dialog collects information appropriate to the task it needs to do. Once you have supplied that information (for example, the new method name as shown in Figure 1-48), click the OK button to complete the refactoring.

To preview the transformations that will be made by a refactoring method before they are committed, click the Preview button prior to clicking the OK button. The refactoring preview shows a hierarchy (a checkbox tree list) of the changes that will be made with text panes showing a before and after view of the affected code (see Figure 1-49). If you want to exclude a particular change from the refactoring operation, uncheck it in the tree list.

Figure 1-49. Rename Method preview.

[View full size image]

1.7.4. Local history

Every time you make a change to a file and save it, a snapshot of that file at that moment in time is recorded to the Eclipse local history. This provides a way to revert back to an earlier version of a file or to compare the current version with an earlier version to see the changes that have been made. Every entry in the local history is identified by the date and time it was created.

Note that "local history" is really local to the machine; it is never stored in CVS or another source code repository. This means that the history is only available to you, not to other users. This might be a surprise to VisualAge for Java or ENVY users who expect "method editions" to be available in the repository.

To compare the current state of a file with an earlier version, right-click on the file and select the Compare With > Local History... command from the context menu. This opens the Compare with Local History dialog (see Figure 1-50). Select any item in the history list to see a comparison relative to the current state of the file.

Figure 1-50. Compare with Local History dialog.

[View full size image]

To replace the current version of a file with an earlier version, right-click on the file and select the Replace With > Local History... command from the context menu. This opens the Replace from Local History dialog, which is almost identical to the local history comparison dialog with the addition of Replace and Cancel buttons.

The General > Workspace > Local History preference page (see Figure 1-51) determines how much information is stored in local history. You can control how many days worth of changes are maintained, how many unique changes per file are maintained, and how large the entire local history is allowed to grow.

Figure 1-51. Local History preference page.

[View full size image]

1.7.5. File extension associations

In addition to the built-in Java editor, Eclipse includes built-in editors for text files, plug-in development files (such as plugin.xml, fragment.xml, and feature.xml), and others.

You can change which editor is assigned to a specific file type using the General > Editors > File Associations preference page (see Figure 1-52). To change the editor, select the file type in the File types list, select the desired editor type in the Associated editors list, and click the Default button. If the desired editor type is not shown, use the File types > Add button to add it to the list.

Figure 1-52. File Associations preference page.

[View full size image]

To add an editor association for a file type not listed in the File types list, click the File types > Add button to reveal the New File Type dialog, as shown in Figure 1-53. For example, to add an editor for HTML files, enter "*.html" into the File type field and click the OK button.

Once the new file type has been added, an editor must be assigned to it. Click the Associated editors > Add button to open the Editor Selection dialog. By default, the various built-in editor types will be shown in the editor list.

To see a list of available external editors, select the External Programs radio button (see Figure 1-54). If you have an HTML editor (such as Microsoft FrontPage) installed in your system, select it from the list and click the OK button. That editor will be added to the Associated editors list and automatically made the default (assuming that no other default was in place).