Formatting Java code

This is an extrapolation of the formatting instructions in GNU's standards documentation.

New Java code for GNU Crypto should be written in "GNU style", with slight modifications for Java. The usual rules for Java code are:

The following is a basic example of how to format your source code:

/* One line to describe the class.
   Copyright (C) 2004  Free Software Foundation, Inc.

This file is part of GNU Crypto.

GNU Crypto is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.

GNU Crypto is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; see the file COPYING.  If not, write to the

   Free Software Foundation Inc.,
   59 Temple Place - Suite 330,
   Boston, MA 02111-1307

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version.  */

package ...;

import ...;

public class ClassName extends SuperClass implements Interface

  // Constants and fields.
  // -------------------------------------------------------------------------

  public static final Object CONSTANT;

  private final Object field;

^L// Constructors.
  // -------------------------------------------------------------------------

  public ClassName(final Object field)
    this.field = field;

  public ClassName()

^L// Class methods.
  // -------------------------------------------------------------------------

  public static Object classMethod() throws SomeException

^L// Instance methods.
  // -------------------------------------------------------------------------

  public Object getField()
    return field;