Jacobe is a configurable code beautifier for the Java^TM programming language (edition 1.4). It is possible to let Jacobe print your Java code according to the widely used layout rules of Sun Microsystems or customize it to your own standards.

The documentation of Jacobe is only on-line available, hence it is advised to bookmark this page. If there is something you cannot find in the documentation, please let us know: support@tiobe.com.

Rules Overview

See section Rules for a detailed explanation of the available rules.

id	rule name	sun	pars	kind
1	indent		4	HOR
2	keywordspaceopenparen		1	HOR
3	spaceinfixopspace		1	HOR
4	spacesep		0	HOR
5	spaceassignspace		1	HOR
6	sepspace		1	HOR
7	spacedotspace		0	HOR
8	prefixopspace		0	HOR
9	spacepostfixop		0	HOR
10	openparenspacestatspacecloseparen		0	HOR
11	castspace		1	HOR
12	methodnamespace		0	HOR
13	horspaceslineterm			HOR
14	lineterm		0	VERT
15	methodblanklines		1	VERT
16	linetermblockopenbrace		0	VERT
17	linetermclassopenbrace		0	VERT
18	linetermblockclosebrace		1	VERT
19	statlineterm		1	VERT
20	declblanklinesstat		1	VERT
21	blanklinescomment		1	VERT
22	decllineterm		1	VERT
23	sectionblanklines		2	VERT
24	classblanklines		2	VERT
25	openbraceclasslineterm		1	VERT
26	colonlineterm		1	VERT
27	blanklinescase		1	VERT
28	closebracelineterm		1	VERT
29	openparenspacegroupspacecloseparen		0	HOR
30	openparenspacemethodspacecloseparen		0	HOR
31	openparenspacecastspacecloseparen		0	HOR
32	linetermarrayinitopenbrace		0	VERT
33	indenttab		1	HOR
34	methodcallspaceopenparen		0	HOR
35	openbracelinetermclosebrace		0	VERT
36	openparenspacecloseparen		0	HOR
37	closebracelinetermelse		0	VERT
38	linetermclassclosebrace		1	VERT
39	linetermcatch		0	VERT
40	linetermarrayinitclosebrace		0	VERT
41	spaceopenbrace		1	HOR
42	linetermdotlineterm		0	VERT
43	openbracespaceclosebrace		0	HOR
44	linetermsep		0	VERT
45	openbraceblocklineterm		1	VERT
46	openbracearrayinitlineterm		0	VERT
47	semicolonlinetermelse		1	VERT
48	linetermextends		0	VERT
49	linetermimplements		0	VERT
50	linetermthrows		0	VERT
51	opencommentspace		1	HOR
52	linetermmethodopenbrace		0	VERT
53	linetermmethodclosebrace		1	VERT
54	openbracemethodlineterm		1	VERT
55	classspacename		1	HOR
56	typespacename		1	HOR
57	spaceelse		1	HOR
58	spacecatch		1	HOR
59	spaceextends		1	HOR
60	extendsspace		1	HOR
61	modifierslineterm		0	VERT
62	modifiersspace		1	HOR
63	indentcase		0	HOR
86	wrap		80	VERT
87	wrapinfixoplineterm		1	VERT
88	wraplineterminfixop		1	VERT
90	returntypelineterm		1	HOR
92	indentcontinuation		2	HOR
93	closebracelinetermdowhile		0	VERT
99	wrapcommalineterm		1	VERT
100	lineterminfixop		0	VERT
101	infixoplineterm		0	VERT
103	linetermopenbracket		0	VERT
104	prefixoplineterm		0	VERT
105	linetermpostfixop		0	VERT
106	indentbraces		0	HOR
107	openbracketspacedimspaceclosebracket		0	HOR
108	openbracketspaceindexspaceclosebracket		0	HOR
109	openbracketspaceclosebracket		0	HOR
110	arrayinitclosebracelineterm		0	VERT
111	openbracespacearrayinitspaceclosebrace		0	HOR
112	insertbraces
113	wraplinetermcomma		1	VERT
114	linetermcomma		0	VERT
115	commalineterm		0	VERT
116	openparenlineterm		0	VERT
117	linetermcloseparen		0	VERT
118	assoplineterm		0	VERT

Contents

  Availability
  Synopsis
  Glossary of Terms
  Rules
    Overview
    Indentation
      Line Length
      Wrapping Lines
    Comments
    Declarations and Statements
      Declarations
      Simple Statements
      Compound Statements
      If Statements
      Do-While Statements
      Switch Statements
      Try-Catch Statements
    White Space
      Blank Lines
      Spaces

Availability

Jacobe accepts Java code conforming to the Java 2 (Edition 1.4) syntax. This is the Java version as defined by Sun Microsystems. Jacobe is available for the following operating systems: Windows 95/98/ME/NT/2K/XP as a command shell application and Linux kernel versions 2.1 and higher.

Synopsis

jacobe <option>... <input>...

Here, <input> could be a file name, a directory name (meaning: beautify recursively), a wildcard or the symbol "-" (meaning: read from standard input). For instance, the call jacobe <file>.java pretty prints the Java file <file>.java according to the default configuration, i.e., the configuration described by the provided configuration file sun.cfg. The result is written to the file <file>.java.jacobe. An example of a more complex call is jacobe src/*.java src/com/.

The possible values for <option> are listed in the table below. Note that spaces act as separators and should therefore not be used in options.

Glossary of Terms

In order to get an unambigious picture of the meaning of the rules defined in the next section, it is important to have a precize definition of the terms used. The table below gives an overview of these terms.

Rules

This section gives a detailed overview of all rules supported by the current version of Jacobe.

Overview

Rules are specified in the following way.

1

indent

4

HOR

In the first two columns the rule number and rule identification is given. The symbol is used to indicate that a rule is part of the default Sun configuration (either explicitly or implicitly). Rules that can be configured by the user are denoted with a sign. If the user does not specify an argument for such a rule the indicated default value will be used. The last column indicates whether it concerns a horizontal or vertical rule. Horizontal rules add or remove spaces and/or tabs, whereas vertical rules add or remove line terminators.

This particular example denotes rule 1 called "indent" which is a parametrized rule that is part of the Sun configuration. The default value of this horizontal rule is 4.

The rules of Jacobe are described in full detail in the following subsections. The subsections follow the sections of the coding conventions document of Sun Microsystems.

Indentation

1

indent

4

HOR

Description: Use a fixed number of spaces for indentation. An indentation starts at the beginning of a nested statement and ends at the end of the nested statement, provided that the nested statement starts at a new line.

For instance, --indent=4 transforms

public class Status {
// calculate failure status
  boolean failure() {
    return !status;

public class Status {
    // calculate failure status
    boolean failure() {
        return !status;

Switching on both indent (rule 1) and indenttab (rule 33) at the same time will result in undefined behaviour.

33

indenttab

1

HOR

Description: Use a fixed number of tabs for indentation. An indentation starts at the beginning of a nested statement and ends at the end of the nested statement, provided that the nested statement starts at a new line.

For instance, assuming that your tab is set to 4 spaces, --indenttab=1 transforms

public class Status {
// calculate failure status
  boolean failure() {
    return !status;

public class Status {
    // calculate failure status
    boolean failure() {
        return !status;

Switching on both indent (rule 1) and indenttab (rule 33) at the same time will result in undefined behaviour.

Line Length

86

wrap

80

VERT

Description: There is a fixed maximum number of characters per line. In case a line exceeds the maximum line length a line terminator is inserted at a line break point closest to the maximum column position. Line break points are defined by switching on specific line wrapping rules such as wraplineterminfixop (rule 88). After a line terminator has been inserted, the next line is indented the number of indentation levels specified by rule indentcontinuation (rule 92).

See specific line breaking rules (starting with wrap) for examples of line wrapping.

IMPORTANT NOTE. This is the first Jacobe version that supports line wrapping. Its current implementation is limited. Only wrapping of expressions in conditions and statements is supported. For instance, wrapping of parameter lists is not yet available.

Wrapping Lines

87

wrapinfixoplineterm

1

VERT

Description: Break a specific number of times after an operator in case a line exceeds the maximum line length. The maximum line length is specified by rule wrap (rule 86).

For instance, --wrapinfixoplineterm=1 --wrap=60 --indent --indentcontinuation transforms

int delta = height - fontMetrics.getAscent() - fontMetrics.getDescent();

int delta = height - fontMetrics.getAscent() -
        fontMetrics.getDescent(); 

This rule is especially powerful if used in combination with lineterminfixop (rule 100) and infixoplineterm (rule 101). For instance, --wrapinfixoplineterm=1 --wrap=60 --indent --indentcontinuation --lineterminfixop=0 --infixoplineterm=0 transforms

if (e.getKeyCode() == KeyEvent.VK_UP
        || e.getKeyCode() == KeyEvent.VK_DOWN) {

if (e.getKeyCode() == KeyEvent.VK_UP ||
        e.getKeyCode() == KeyEvent.VK_DOWN) {

Note that switching on simultaneously both this rule and wraplineterminfixop (rule 88) will result in undefined behaviour.

88

wraplineterminfixop

1

VERT

Description: Break a specific number of times before an operator in case a line exceeds the maximum line length. The maximum line length is specified by rule wrap (rule 86).

For instance, --wraplineterminfixop=1 --wrap=60 --indent --indentcontinuation transforms

int delta = height - fontMetrics.getAscent() - fontMetrics.getDescent();

int delta = height - fontMetrics.getAscent()
        - fontMetrics.getDescent(); 

This rule is especially powerful if used in combination with lineterminfixop (rule 100) and infixoplineterm (rule 101). For instance, --wraplineterminfixop=1 --wrap=60 --indent --indentcontinuation --lineterminfixop=0 --infixoplineterm=0 transforms

if (e.getKeyCode() == KeyEvent.VK_UP ||
        e.getKeyCode() == KeyEvent.VK_DOWN) {

if (e.getKeyCode() == KeyEvent.VK_UP
        || e.getKeyCode() == KeyEvent.VK_DOWN) {

Note that switching on simultaneously both this rule and wrapinfixoplineterm (rule 87) will result in undefined behaviour.

92

indentcontinuation

2

HOR

Description: Indent a specific number of indentation levels after a line of code has been wrapped.

For instance, --indentcontinuation=2 --indent=4 --wrap=60 --wraplineterminfixop=1 transforms

if ((currentIndex < length) && (rawdata.charAt(currentIndex) == '=')) {

if ((currentIndex < length)
        && (rawdata.charAt(currentIndex) == '=')) { 

99

wrapcommalineterm

1

VERT

Description: Break a specific number of times after a comma in the argument list of a method or constructor invocation in case a line exceeds the maximum line length. The maximum line length is specified by rule wrap (rule 86).

For instance, --wrapcommalineterm=1 --indent=4 --wrap=80 --indentcontinuation=2 transforms

vaporWare.sell("Product off the shelf", orderQuantity, customerCode, productCode, orderNumber);

vaporWare.sell("Product off the shelf", orderQuantity, customerCode,
        productCode, orderNumber);

113

wraplinetermcomma

1

VERT

Description: Break a specific number of times before a comma in the argument list of a method or constructor invocation in case a line exceeds the maximum line length. The maximum line length is specified by rule wrap (rule 86).

For instance, --wraplinetermcomma=1 --indent=4 --wrap=80 --indentcontinuation=2 transforms

vaporWare.sell("Product off the shelf", orderQuantity, customerCode, productCode, orderNumber);

vaporWare.sell("Product off the shelf", orderQuantity, customerCode
        , productCode, orderNumber);

Comments

51

opencommentspace

1

HOR

Description: There should be a specified number of spaces after an opening comment. This rule holds for all available kinds of Java comments. For instance, --opencommentspace=1 transforms

/*  this should be fixed very soon */
int x; //x coordinate in pixels

/* this should be fixed very soon */
int x; // x coordinate in pixels

Declarations and Statements

26

colonlineterm

1

VERT

Description: There should be a specified number of line terminators after a colon (':'). For instance, --colonlineterm=1 --indent transforms

switch ( x ) {
case 1: return x + 1;

switch ( x ) {
case 1:
    return x + 1;

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

41

spaceopenbrace

1

HOR

Description: There should be a specified number of spaces before an opening brace ('{'). For instance, --spaceopenbrace=1 transforms

class Status{

class Status {

28

closebracelineterm

1

VERT

Description: There should be a specified number of line terminators after a close brace ('}'). For instance, --closebracelineterm=1 --indent transforms

while (x > 0) {
  x--;
} y = x;

while (x > 0) {
  x--;
}
y = x;

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

43

openbracespaceclosebrace

0

HOR

Description: There should be a specified number of spaces between an empty pair of opening and close braces ('{' and '}'). For instance, --openbracespaceclosebrace=0 transforms

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

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

35

openbracelinetermclosebrace

0

VERT

Description: There should be a specified number of line terminators between an empty opening brace ('{') and closing brace ('}'). For instance, --openbracelinetermclosebrace=0 transforms

catch (Exception e) {
    }

catch (Exception e) { }

The best results are obtained if this rule is applied in combination with openbracespaceclosebrace (rule 43). The result of applying --openbracelinetermclosebrace=0 --openbracespaceclosebrace=0 to the previous example is

catch (Exception e) {}

Observe that this rule overrules the following rules that also deal with opening and closing braces: linetermblockclosebrace (rule 18), openbraceclasslineterm (rule 25), linetermclassclosebrace (rule 38), linetermarrayinitclosebrace (rule 40), openbraceblocklineterm (rule 45) and openbracearrayinitlineterm (rule 46).

36

openparenspacecloseparen

0

HOR

Description: There should be a specified number of spaces between an empty opening parenthesis ('(') and closing parenthesis (')'). For instance, --openparenspacecloseparen=0 transforms

x = getStatus( );

x = getStatus();

Observe that this rule overrules the following rules that also deal with opening and closing parentheses: openparenspacestatspacecloseparen (rule 10), openparenspacegroupspacecloseparen (rule 29), openparenspacemethodspacecloseparen (rule 30) and openparenspacecastspacecloseparen (rule 31).

103

linetermopenbracket

0

VERT

Description: There should be a specified number of line terminators before an opening bracket ('['). For instance, --linetermopenbracket=0 transforms

public LineMetrics getLineMetrics(char
        [] chars) {

public LineMetrics getLineMetrics(char [] chars) {

106

indentbraces

0

VERT

Description: There should be a specified number of additional indentation levels before an opening brace ('{'), and the additional indentation holds for the duration of the block. For instance, --indentbraces=1 transforms

public LineMetrics getLineMetrics(char[] chars)
{
    ...
}

public LineMetrics getLineMetrics(char[] chars)
    {
         ...
    }

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) and linetermblockopenbrace=1 (rule 16) at the same time.

107

openbracketspacedimspaceclosebracket

0

HOR

Description: There should be a specified number of spaces after an opening bracket ('[') and before a closing bracket (']') of an array dimension. For instance, --openbracketspacedimspaceclosebracket=1 transforms

String[] str = new String[10];

String[] str = new String[ 10 ];

108

openbracketspaceindexspaceclosebracket

0

HOR

Description: There should be a specified number of spaces after an opening bracket ('[') and before a closing bracket (']') of an array index. For instance, --openbracketspaceindexspaceclosebracket=1 transforms

return str[i];

return str[ i ];

109

openbracketspaceclosebracket

0

HOR

Description: There should be a specified number of spaces after an opening bracket ('[') and before a closing bracket (']') of an empty array dimension. For instance, --openbracketspaceclosebracket=1 transforms

String[] str2 = new String[] {"foo", "bar",};

String[ ] str2 = new String[ ] {"foo", "bar",};

Declarations

22

decllineterm

1

VERT

Description: Each declaration should be followed by a specified number of line terminators. For instance, --decllineterm=1 transforms

int x; int y;

int x;
int y;

Note that this rule does not take into account multiple declarators on the same line (e.g., int x, y;). The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

61

modifierslineterm

0

VERT

Description: There should be a specified number of line terminators after a list of modifiers ("public", "final", "synchronized", etc.). For instance, --modifierslineterm=0 transforms

public
class ImageFormatException {

public class ImageFormatException {

This rule only applies to line terminators at the end of a list of modifiers, not to individual modifiers. If the value of this rule is unequal to zero, the best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

62

modifiersspace

1

HOR

Description: There should be a specified number of spaces after a list of modifiers ("public", "final", "synchronized", etc.). For instance, --modifiersspace=1 transforms

private    Color control = UIManager.getColor("control");

private Color control = UIManager.getColor("control");

This rule only applies to line spaces at the end of a list of modifiers, not to individual modifiers.

56

typespacename

1

HOR

Description: There should be a specified number of spaces between a type and its name in a declaration. For instance, --typespacename=1 transforms

int   x;
void  method() {}

int x;
void method() {}

55

classspacename

1

HOR

Description: There should be a specified number of spaces between the "class" keyword of a class declaration and its name. For instance, --classspacename=1 transforms

class   Status {}

class Status {}

17

linetermclassopenbrace

0

VERT

Description: Use a specified number of line terminators before an open brace ('{') of a class or interface declaration. For instance, --linetermclassopenbrace=0 transforms

class Status
{

class Status {

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

25

openbraceclasslineterm

1

VERT

Description: There should be a specified number of line terminators after an open brace ('{') of a class or interface declarations. For instance,--openbraceclasslineterm=1 --indent transforms

public class Status { int val;
}

public class Status {
    int val;
}

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

38

linetermclassclosebrace

1

VERT

Description: There should be a specified number of line terminators before a close brace ('}') of a class or interface declaration. For instance, --linetermclassclosebrace=1 transforms

class Status {
    int x;
    int y; }

class Status {
    int x;
    int y;
}

59

spaceextends

1

HOR

Description: There should be a specified number of spaces before an "extends" keyword of a class or interface declaration. For instance, --spaceextends=1 transforms

public class JFrame   extends Frame {

public class JFrame extends Frame {

60

extendsspace

1

HOR

Description: There should be a specified number of spaces after an "extends" keyword of a class or interface declaration. For instance, --extendsspace=1 transforms

public class JFrame extends   Frame {

public class JFrame extends Frame {

48

linetermextends

0

VERT

Description: There should be a specified number of line terminators before an "extends" keyword of a class or interface declaration. For instance, --linetermextends=0 transforms

class SpecialStatus
extends Status {
    int z;
}

class SpecialStatus extends Status {
    int z;
}

49

linetermimplements

0

VERT

Description: There should be a specified number of line terminators before an "implements" keyword of a class declaration. For instance, --linetermimplements=1 --indent transforms

class Status implements Runnable {
}

class Status
    implements Runnable {
}

50

linetermthrows

0

VERT

Description: There should be a specified number of line terminators before a "throws" keyword of a constructor or method declaration. For instance, --linetermthrows=1 --indent transforms

public Remote lookup(String name) throws java.rmi.RemoteException;

public Remote lookup(String name)
    throws java.rmi.RemoteException;

52

linetermmethodopenbrace

0

VERT

Description: There should be a specified number of line terminators before an open brace of a constructor or method declaration. For instance, --linetermmethodopenbrace=0 --indent transforms

public int getStatus()
{
    return status;
}

public int getStatus() {
    return status;
}

54

openbracemethodlineterm

1

VERT

Description: There should be a specified number of line terminators after an open brace of a constructor or method declaration. For instance, --linetermmethodopenbrace=1 --indent transforms

public int getStatus() { return status; }

public int getStatus() {
    return status; }

53

linetermmethodclosebrace

1

VERT

Description: There should be a specified number of line terminators before an open brace of a constructor or method declaration. For instance, --linetermmethodclosebrace=1 --indent transforms

public int getStatus() { return status; }

public int getStatus() { return status;
}

32

linetermarrayinitopenbrace

0

VERT

Description: The are should be a specified number of line terminators before the opening brace ('{') of an array initialization. For instance, --linetermarrayinitopenbrace=0 transforms

int[] array =
    { 1, 2, 3 };

int[] array = { 1, 2, 3 };

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

46

openbracearrayinitlineterm

0

VERT

Description: There should be a specified number of line terminators after an open brace ('{') of an array initialization. For instance,--openbracearrayinitlineterm=0 --indent transforms

int[] array = {
    1, 2, 3 };

int[] array = { 1, 2, 3 };

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

40

linetermarrayinitclosebrace

0

VERT

Description: There should be a specified number of line terminators before the closing brace ('}') of an array initialization. For instance, --linetermarrayinitclosebrace=0 transforms

int[] array = { 1, 2, 3
    };

int[] array = { 1, 2, 3 };

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

110

arrayinitclosebracelineterm

0

VERT

Description: There should be a specified number of line terminators after the closing brace ('}') of an array initialization. For instance, --arrayinitclosebracelineterm=0 transforms

processArray(new Object[] {obj1, obj2, obj3}
    );

processArray(new Object[] {obj1, obj2, obj3});

111

openbracespacearrayinitspaceclosebrace

0

HOR

Description: There should be a specified number of spaces after the opening brace ('{') and before the closing brace ('}') of an array initialization. For instance, --openbracespacearrayinitspaceclosebrace=0 transforms

int[] array = { 1, 2, 3 };

int[] array = {1, 2, 3};

90

returntypelineterm

0

VERT

Description: There should be a specified number of line terminators after the return type of a method declaration. For instance, --returntypelineterm=0 transforms

public int
        getStatus()

public int getStatus()

Simple Statements

19

statlineterm

1

VERT

Description: Each statement should end with a specified number of line terminators. For instance, --statlineterm=1 --indent transforms

x = z; y = z;

x = z;
y = z;

The statements of a for loop are not affected by this rule. The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

34

methodcallspaceopenparen

0

HOR

Description: There should be a specified number of spaces between a method name and its following opening parenthesis in a method call. For instance, --methodcallspaceopenparen=0 transforms

x = length (y);

x = length(y);

42

linetermdotlineterm

0

VERT

Description: There should be a specified number of line terminators at either side of a dot symbol ('.'). For instance, --linetermdotlineterm=0 transforms

x.value = y
    .value;

x.value = y .value;

The best results are obtained if this rule is applied in combination with spacedotspace (rule 7). The result of applying --linetermdotlineterm=0 --spacedotspace=0 to the previous example is

x.value = y.value;

44

linetermsep

0

VERT

Description: There should be a specified number of line terminators before a comma (',') or semicolon (';'). For instance, --linetermsep=0 transforms

status = 0
    ;

status = 0 ;

The best results are obtained if this rule is applied in combination with spacesep (rule 4). The result of applying --linetermsep=0 --spacesep=0 to the previous example is

status = 0;

100

lineterminfixop

0

VERT

Description: There should be a specified number of line terminators before an infix operator. For instance, --lineterminfixop=0 transforms

return square.length
    * square.width;

return square.length * square.width;

101

infixoplineterm

0

VERT

Description: There should be a specified number of line terminators after an infix operator. For instance, --infixoplineterm=0 transforms

return square.length *
    square.width;

return square.length * square.width;

104

prefixoplineterm

0

VERT

Description: There should be a specified number of line terminators after a prefix operator. For instance, --prefixoplineterm=0 transforms

if (!
    (obj instanceof FilePermission)) {

if (! (obj instanceof FilePermission)) {

105

linetermpostfixop

0

VERT

Description: There should be a specified number of line terminators before a postfix operator. For instance, --linetermpostfixop=0 transforms

for ( i = 0 ; i < currentSelection ; i
    ++ ) {

for ( i = 0 ; i < currentSelection ; i ++ ) {

114

linetermcomma

0

VERT

Description: There should be a specified number of line terminators before a comma in the argument list of a method or constructor invocation. For instance, --linetermcomma=0 transforms

vaporWare.sell("Product off the shelf", orderQuantity, customerCode
        , productCode, orderNumber);

vaporWare.sell("Product off the shelf", orderQuantity, customerCode, productCode, orderNumber);

115

commalineterm

0

VERT

Description: There should be a specified number of line terminators after a comma in the argument list of a method or constructor invocation. For instance, --commalineterm=0 transforms

vaporWare.sell("Product off the shelf", orderQuantity, customerCode,
        productCode, orderNumber);

vaporWare.sell("Product off the shelf", orderQuantity, customerCode, productCode, orderNumber);

116

openparenlineterm

0

VERT

Description: There should be a specified number of line terminators after the opening parenthesis of a method or constructor invocation. For instance, --openparenlineterm=0 transforms

vaporWare.sell(
        "Product off the shelf", orderQuantity, customerCode, productCode, orderNumber);

vaporWare.sell("Product off the shelf", orderQuantity, customerCode, productCode, orderNumber);

117

linetermcloseparen

0

VERT

Description: There should be a specified number of line terminators before the closing parenthesis of a method or constructor invocation. For instance, --linetermcloseparen=0 transforms

vaporWare.sell("Product off the shelf", orderQuantity, customerCode, productCode, orderNumber
        );

vaporWare.sell("Product off the shelf", orderQuantity, customerCode, productCode, orderNumber);

118

assoplineterm

0

VERT

Description: There should be a specified number of line terminators after the assignment operator in an assignment statement. For instance, --assoplineterm=0 transforms

delta =
        height - fontMetrics.getAscent() - fontMetrics.getDescent();

delta = height - fontMetrics.getAscent() - fontMetrics.getDescent();

Compound Statements

16

linetermblockopenbrace

0

VERT

Description: Use a specified number of line terminators before an open brace ('{') of a block statement. For instance, --linetermblockopenbrace=0 transforms

if (x == y)
{

if ( x == y ) {

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

45

openbraceblocklineterm

1

VERT

Description: There should be a specified number of line terminators after an open brace ('{') of a block statement. For instance,--openbraceblocklineterm=1 --indent transforms

while (x > 0) { x--;
}

while (x > 0) {
    x--;
}

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

18

linetermblockclosebrace

1

VERT

Description: There should be a specified number of line terminators before a close brace ('}') of a block statement. For instance, --linetermblockclosebrace=1 transforms

while (x > 0) {
    x--; }

while (x > 0) {
    x--;
}

The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

112

insertbraces

Description: A control statement such as if, for, while should be followed by a block statement (a statement surrounded by braces ({ ... })). For instance, --insertbraces transforms

while (x > 0)
    x--;

while (x > 0) {
    x--;
}

The best results are obtained by applying some of the following rules at the same time.

• indent (rule 1) or indenttab (rule 33)
• openbraceblocklineterm (rule 45)
• linetermblockopenbrace (rule 16)
• spaceopenbrace (rule 41)
• closebracelineterm (rule 28)
• linetermblockclosebrace (rule 18)

If Statements

57

spaceelse

1

HOR

Description: There should be a specified number of spaces before an else keyword. For instance, --spaceelse=1 transforms

if (x > 0) {
}else {
}

if (x > 0) {
} else {
}

37

closebracelinetermelse

0

VERT

Description: There should be a specified number of line terminators before an else keyword that is preceded by a block statement. For instance, --closebracelinetermelse=0 transforms

if (x > 0) {
}
else {
}

if (x > 0) {
} else {
}

Observe that this rule overrules rule closebracelineterm (rule 28).

47

semicolonlinetermelse

1

VERT

Description: There should be a specified number of line terminators before an else keyword that is not preceded by a block statement. For instance, --semicolonlinetermelse=1 transforms

if (x > 0) x = 0; else x = 1;

if (x > 0) x = 0;
else x = 1;

Do-While Statements

93

closebracelinetermdowhile

0

VERT

Description: There should be a fixed number of line terminators after the closing brace of a do while loop. For instance, --closebracelinetermdowhile=0 transforms

do {
    x++;
}
while (x < 10);

do {
    x++;
} while (x < 10);

Switch Statements

27

blanklinescase

1

VERT

Description: There should be a fixed number of blank lines before a case block in a switch statement (except for the first one). For instance, --blanklinescase=1 --indent transforms

switch ( x ) {
case 1:
    return x + 1;
case 2:
    return 5;
}

switch ( x ) {
case 1:
    return x + 1;

case 2:
    return 5;
}

No blank lines will be introduced before empty cases. Observe that this rule might interact with rule blanklinescomment (rule 21) in case comments are involved.The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

63

indentcase

0

HOR

Description: a case block is indented a fixed number of indentation levels. For instance, --indentcase=0 --indent transforms

switch ( x ) {
case 1:
    return x + 1;

case 2:
    return 5;

switch ( x ) {
    case 1:
        return x + 1;

    case 2:
        return 5;

Observe that this rule overrules indent (rule 1) and indenttab (rule 33).

Try-Catch Statements

58

spacecatch

1

HOR

Description: There should be a specified number of spaces before a catch or finally keyword. For instance, --spacecatch=1 transforms

try {
    input = readStream(reader);
}   catch (ReadException e) {
}

try {
    input = readStream(reader);
} catch (ReadException e) {
}

39

linetermcatch

0

VERT

Description: There should be a specified number of line terminators before a catch or finally keyword. For instance, --linetermcatch=0 transforms

try {
    input = readStream(reader);
}
catch (ReadException e) {
}

try {
    input = readStream(reader);
} catch (ReadException e) {
}

Observe that this rule overrules rule closebracelineterm (rule 28).

White Space

14

lineterm

0

HOR

Description: Use a specific line terminator. This rule is parameterizable by the user: mode 1, replace each line terminator by carriage return (Macintosh style); mode 2, replace each line terminator by line feed (Unix style); mode 3, replace each line terminator by carriage return line feed (Windows style). The default mode, mode 0 is the mode for the platform you are using.

Blank Lines

15

methodblanklines

1

VERT

Description: There should be a fixed number of blank lines after a method declaration in a class (except for the last one). For instance, --methodblanklines=1 transforms

public void setValue(int i) {
    val = i;
}



public int getValue() {
{
    return val;
}

public void setValue(int i) {
    val = i;
}

public int getValue() {
    return val;
}

Observe that this rule might interact with rule blanklinescomment (rule 21) in case comments are involved.

20

declblanklinesstat

1

VERT

Description: There should be a fixed number of blank lines between declarations and statements. For instance, --declblanklinesstat=1 --indent transforms

public int factor(int i) {
    int j = length(i);
    return (j + 1) * (j - 1);
}

public int factor(int i) {
    int j = length(i);

    return (j + 1) * (j - 1);
}

Observe that this rule might interact with rule blanklinescomment (rule 21) in case comments are involved. The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

21

blanklinescomment

1

VERT

Description: There should be a fixed number of blank lines before block comments (between '/*' and '*/') that start at the beginning of a line. For instance --blanklinescomment=1 --indent transforms

public int factor(int i) {
    /* introduce var j for sharing */
    int j = length(i);

public int factor(int i) {

    /* introduce var j for sharing */
    int j = length(i);

Observe that this rule might conflict with rules methodblanklines (rule 15), sectionblanklines (rule 23), classblanklines (rule 24) and blanklinescase (rule 27). The best results are obtained by applying rule indent (rule 1) or indenttab (rule 33) at the same time.

23

sectionblanklines

2

VERT

Description: There should be a fixed number of blank lines after package and import sections. For instance, --sectionblanklines=2 transforms

import java.util.Vector;

public class Status {

import java.util.Vector;


public class Status {

Observe that this rule might interact with rule blanklinescomment (rule 21) in case comments are involved.

24

classblanklines

2

VERT

Description: There should be a fixed number of blank lines after a class declaration (excluding the last one). For instance, --classblanklines=2 transforms

public class Status {
}

class SpecialStatus extends Status {
}

public class Status {
}


class SpecialStatus extends Status {
}

This rule also holds for inner classes. Observe that this rule might interact with rule blanklinescomment (rule 21) in case comments are involved.

Spaces

2

keywordspaceopenparen

1

HOR

Description: There should be a specified number of spaces between a Java keyword and a subsequent opening parenthesis '('. For instance, --keywordspaceopenparen=1 transforms

while(x > 0)

while (x > 0)

12

methodnamespace

0

HOR

Description: There should be a specified number of spaces between a method name and its formal parameter list in a method definition. For instance, --methodnamespace=0 transforms

public int length (int x, int y)

public int length(int x, int y)

4

spacesep

0

HOR

Description: There should be a specified number of spaces before a comma (',') or semicolon (';'). For instance, --spacesep=0 transforms

x = y ;

x = y;

6

sepspace

1

HOR

Description: There should be a specified number of spaces after a comma (',') or semicolon(';'). For instance, --sepspace=1 transforms

public int length(int x,int y)

public int length(int x, int y)

5

spaceassignspace

1

HOR

Description: There should be a specified number of spaces at each side of a Java assignment operator. For instance, --spaceassignspace=1 transforms

x=y;

x = y;

7

spacedotspace

0

HOR

Description: There should be a specified number of spaces at either side of the dot operator ('.'). For instance, --spacedotspace=0 transforms

x . val = y . val;

x.val = y.val;

8

prefixopspace

0

HOR

Description: There should be a specified number of spaces after a Java prefix operator. For instance, --prefixopspace=0 transforms

x = - y;

x = -y;

3

spaceinfixopspace

1

HOR

Description: There should be a specified number of spaces at each side of a Java infix operator. For instance, --spaceinfixopspace=1 transforms

x = y+z;

x = y + z;

9

spacepostfixop

0

HOR

Description: There should be a specified number of spaces before a Java postfix operator. For instance, --spacepostfixop=0 transforms

x = y ++;

x = y++;

11

castspace

1

HOR

Description: There should be a specified number of spaces after a cast. For instance, --castspace=1 transforms

x = (int)y;

x = (int) y;

31

openparenspacecastspacecloseparen

0

HOR

Description: There should be a specified number of spaces after an opening parenthesis ('(') and before a closing parenthesis (')') of a cast expression. For instance, --openparenspacecastspacecloseparen=0 transforms

x = ( int ) y;

x = (int) y;

10

openparenspacestatspacecloseparen

0

HOR

Description: There should be a specified number of spaces after an opening parenthesis ('(') and before a closing parenthesis (')') that occur in a statement context such as in conditions of an if or while statement. For instance, --openparenspacestatspacecloseparen=0 transforms

if ( x == y )

if (x == y)

29

openparenspacegroupspacecloseparen

0

HOR

Description: There should be a specified number of spaces after an opening parenthesis ('(') and before a closing parenthesis (')') of a grouped expression. For instance, --openparenspacegroupspacecloseparen=0 transforms

x = ( y + z ) * ( x - z );

x = (y + z) * (x - z);

30

openparenspacemethodspacecloseparen

0

HOR

Description: There should be a specified number of spaces after an opening parenthesis ('(') and before a closing parenthesis (')') of a constuctor/method declarator/call. For instance, --openparenspacemethodspacecloseparen=0 transforms

public int length( int x, int y )

public int length(int x, int y)

Description: There shouldn't be horizontal spaces immediately in front of a line terminator. Note that horizontal spaces at the end of "end of line" comments are considered to be part of the comments. Hence, these will not be removed by this rule.

Send mail to support@tiobe.com with questions or comments about this web site. Legal disclaimer: Sun, Sun Microsystems, the Sun Logo and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. Sun Microsystems, Inc. in no way endorses or is affiliated with TIOBE Software.

Copyright © 2002 TIOBE Software BV