com.spidasoftware.EclipseFormatter
Class Format

java.lang.Object
  com.spidasoftware.EclipseFormatter.Format

Direct Known Subclasses:

GroovyFormat, JavaFormat

public abstract class Format
extends Object

An abstract class that will format source code.

Author:

Nicholas Joodi

Field Summary

protected boolean

correctlyFormatted

Constructor Summary

Format()
A no argument constructor that will create a Format object.

Method Summary

abstract void	format(String fileName, String code) A two-argument method that will take two strings, a fileName and its respective code and format the code.
boolean	isFormatted() A no-argument method that will return a boolean indicating if the code has been formatted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

correctlyFormatted

protected boolean correctlyFormatted

Constructor Detail

Format

public Format()

A no argument constructor that will create a Format object.

Method Detail

isFormatted

public boolean isFormatted()

A no-argument method that will return a boolean indicating if the code has been formatted.

Returns:

a boolean indicating if the file was formatted.

format

public abstract void format(String fileName,
                            String code)

A two-argument method that will take two strings, a fileName and its respective code and format the code.

Parameters:

fileName - The name of that file.

code - The string of code that will be formatted.