Java Programming Style Guidelines

Example if applicable

mypackage, com.company.application.ui

Line, AudioSystem

line, audioSystem

MAX_ITERATIONS, COLOR_RED

getName(), computeTotalWidth()

exportHtmlSource(); // NOT: exportHTMLSource();
openDvdPlayer();    // NOT: openDVDPlayer();

class Person
{
  private String  name_;
  ...
}

void setTopic (Topic topic)  // NOT: void setTopic (Topic value)
                             // NOT: void setTopic (Topic aTopic)
                             // NOT: void setTopic (Topic x)

void connect (Database database) // NOT: void connect (Database db)
                                 // NOT: void connect (Database oracleDB)

fileName; // NOT: filNavn

line.getLength(); // NOT: line.getLineLength();

employee.getName();
matrix.getElement (2, 4);
employee.setName (name);
matrix.setElement (2, 4, value);

isSet, isVisible, isFinished, isFound, isOpen

valueSet.computeAverage();
matrix.computeInverse();

vertex.findNearestVertex();
matrix.findMinElement();

printer.initializeFontSet();

widthScale, nameTextField, leftScrollbar, mainPanel, fileToggle, minLabel,
printerDialog

Collection points;  // of Point
int[]      values;

nPoints, nLines

tableNo, employeeNo

while (Iterator i = points.iterator(); i.hasNext(); ) {
  :
}

for (int i = 0; i < nTables; i++) {
  :
}

get/set, add/remove, create/destroy, start/stop, insert/delete,
increment/decrement, old/new, begin/end, first/last, up/down, min/max,
next/previous, old/new, open/close, show/hide

computeAverage();  // NOT: compAvg();
ActionEvent event; // NOT: ActionEvent e;

boolean isError; // NOT: isNotError
boolean isFound; // NOT: isNotFound

final int  COLOR_RED   = 1;
final int  COLOR_GREEN = 2;
final int  COLOR_BLUE  = 3;

class AccessException
{
  :
}

class DefaultTableCellRenderer
  implements TableCellRenderer
{
  :
}

Point.java

totalSum = a + b + c +
           d + e;

function (param1, param2,
          param3);

setText ("Long line split" +
         "into two parts.");

for (tableNo = 0; tableNo < maxTable;
     tableNo += tableStep)

import java.io.*;
import java.net.*;

import java.rmi.*
import java.rmi.server.*;

import javax.swing.*;
import javax.swing.event.*;

import org.linux.apache.server.*;

floatValue = (float) intValue; // NOT: floatValue = intValue;

float  x, y, z;
float  revenueJanuary, revenueFebrury, revenueMarch;

double[] vertex;  // NOT: double vertex[];
int[]    count;   // NOT: int    count[];

public static void main (String[] arguments)

public double[] computeVertex()

sum = 0;                   // NOT: for (i=0, sum = 0; i < 100; i++)
for (i = 0; i < 100; i++)  //        sum += value[i];
  sum += value[i];

boolean isDone = false; // NOT: isDone = false;
while (!isDone) {       //       :
  :                     // while (!isDone) {
}                       //   :
                        // }

if ((elementNo < 0) || (elementNo > maxElement)||
    elementNo == lastElement) {
  :
}

boolean isFinished      = elementNo < 0 || elementNo > maxElement;
boolean isRepeatedEntry = elementNo == lastElement;
if (isFinished || isRepeatedEntry) {
  :
}

boolean isError = readFile (fileName);
if (!isError) {
  :
}
else {
  :
}

if (isDone)  // NOT: if (isDone) doCleanup();
  doCleanup();

file = openFile (fileName); // NOT: if ((file = openFile (fileName)) != null) {
if (file != null) {         //        :
  :                         //      }
}

private static final int  TEAM_SIZE = 11;
:
Player[] players = new Player[TEAM_SIZE]; // NOT: Player[] players = new Player[11];

double total = 0.0;    // NOT:  double total = 0;
double speed = 3.0e8;  // NOT:  double speed = 3e8;


double sum;
  :
sum = (a + b) * 10.0;

double total = 0.5;  // NOT:  double total = .5;

Thread.sleep (1000);    // NOT: thread.sleep (1000);

for (i = 0; i < nElements; i++)
  a[i] = 0;

while (!isDone) {
  doSomething();
  isDone = moreToDo();
}

while (!isDone)
{
  doSomething();
  isDone = moreToDo();
}

while (!isDone)
  {
    doSomething();
    isDone = moreToDo();
  }

class SomeClass extends AnotherClass
  implements SomeInterface, AnotherInterface
{
  ...
}

public void someMethod ()
  throws SomeException
{
  ...
}

if (condition) {
  statements;
}

if (condition) {
  statements;
}
else {
  statements;
}

if (condition) {
  statements;
}
else if (condition) {
  statements;
}
else {
  statements;
}

for (initialization; condition; update) {
  statements;
}

for (initialization; condition; update)
  ;

while (condition) {
  statements;
}

do {
  statements;
} while (condition);

switch (condition) {
  case ABC :
    statements;
    // Fallthrough
  case DEF :
    statements;
    break;
  case XYZ :
    statements;
    break;
  default :
    statements;
    break;
}

try {
  statements;
}
catch (Exception exception) {
  statements;
}

try {
  statements;
}
catch (Exception exception) {
  statements;
}
finally {
  statements;
}

if (condition)
  statement;

while (condition)
  statement;

for (initialization; condition; update)
  statement;

a = (b + c) * d;               // NOT: a=(b+c)*d
while (true) {                 // NOT: while(true) ...
doSomething (a, b, c, d);      // NOT: doSomething (a,b,c,d);
case 100 :                     // NOT: case 100:
for (i = 0; i < 10; i++) {     // NOT: for(i=0;i<10;i++){

doSomething (parameter); // NOT: doSomething(parameter);
doSomething();           // OK

Matrix4x4 matrix = new Matrix4x4();

double cosAngle = Math.cos (angle);
double sinAngle = Math.sin (angle);

matrix.setElement (1, 1,  cosAngle);
matrix.setElement (1, 2,  sinAngle);
matrix.setElement (2, 1, -sinAngle);
matrix.setElement (2, 2,  cosAngle);

multiply (matrix);

TextFile  file;
int       nPoints;
double    x, y;

if      (a == lowValue)    compueSomething();
else if (a == mediumValue) computeSomethingElse();
else if (a == highValue)   computeSomethingElseYet();

value = (potential        * oilDensity)   / constant1 +
        (depth            * waterDensity) / constant2 +
        (zCoordinateValue * gasDensity)   / constant3;

minPosition     = computeDistance (min,     x, y, z);
averagePosition = computeDistance (average, x, y, z);

switch (value) {
  case PHASE_OIL   : phaseString = "Oil";   break;
  case PHASE_WATER : phaseString = "Water"; break;
  case PHASE_GAS ; : phaseString = "Gas";   break;
}

// Comment spanning
// more than one line

while (true) {       // NOT: while (true) {
  // Do something    //      // Do something
  something();       //        something();
}                    //      }

private Vector  points_;    // of Point
private Set     shapes_;    // of Shape