////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2008 Oliver Burn
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.util.List;
import com.puppycrawl.tools.checkstyle.Defn;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import com.puppycrawl.tools.checkstyle.api.MessageDispatcher;
import com.puppycrawl.tools.checkstyle.api.Utils;
import org.apache.commons.beanutils.ConversionException;
/**
* <p>
* Checks that there is a newline at the end of each file.
* </p>
* <p>
* An example of how to configure the check is:
* </p>
* <pre>
* <module name="NewlineAtEndOfFile"/></pre>
* <p>
* This will check against the platform-specific default line separator.
* </p>
* <p>
* It is also possible to enforce the use of a specific line-separator across
* platforms, with the 'lineSeparator' property:
* </p>
* <pre>
* <module name="NewlineAtEndOfFile">
* <property name="lineSeparator" value="lf"/>
* </module></pre>
* <p>
* Valid values for the 'lineSeparator' property are 'system' (system default),
* 'crlf' (windows), 'cr' (mac) and 'lf' (unix).
* </p>
*
* @author Christopher Lenz
* @author lkuehne
* @version 1.0
*/
public class NewlineAtEndOfFileCheck
extends AbstractFileSetCheck
{
/** the line separator to check against. */
private LineSeparatorOption mLineSeparator =
LineSeparatorOption.SYSTEM;
/** {@inheritDoc} */
public void process(List<File> aFiles)
{
final List<File> files = filter(aFiles);
final MessageDispatcher dispatcher = getMessageDispatcher();
for (final File file : files) {
final String path = file.getPath();
dispatcher.fireFileStarted(path);
RandomAccessFile randomAccessFile = null;
try {
randomAccessFile = new RandomAccessFile(file, "r");
if (!endsWithNewline(randomAccessFile)) {
log(0, "noNewlineAtEOF", path);
}
}
catch (final IOException e) {
///CLOVER:OFF
logIOException(e);
///CLOVER:ON
}
finally {
if (randomAccessFile != null) {
try {
randomAccessFile.close();
}
catch (final IOException e) {
///CLOVER:OFF
logIOException(e);
///CLOVER:ON
}
}
}
fireErrors(path);
dispatcher.fireFileFinished(path);
}
}
/**
* Sets the line separator to one of 'crlf', 'lf' or 'cr'.
*
* @param aLineSeparator The line separator to set
* @throws IllegalArgumentException If the specified line separator is not
* one of 'crlf', 'lf' or 'cr'
*/
public void setLineSeparator(String aLineSeparator)
{
try {
mLineSeparator =
Enum.valueOf(LineSeparatorOption.class, aLineSeparator.trim()
.toUpperCase());
}
catch (IllegalArgumentException iae) {
throw new ConversionException("unable to parse " + aLineSeparator,
iae);
}
}
/**
* Checks whether the content provided by the Reader ends with the platform
* specific line separator.
* @param aRandomAccessFile The reader for the content to check
* @return boolean Whether the content ends with a line separator
* @throws IOException When an IO error occurred while reading from the
* provided reader
*/
private boolean endsWithNewline(RandomAccessFile aRandomAccessFile)
throws IOException
{
final int len = mLineSeparator.length();
if (aRandomAccessFile.length() < len) {
return false;
}
aRandomAccessFile.seek(aRandomAccessFile.length() - len);
final byte lastBytes[] = new byte[len];
aRandomAccessFile.read(lastBytes);
return mLineSeparator.matches(lastBytes);
}
/**
* Helper method to log an IO exception.
* @param aEx the exception that occured
*/
///CLOVER:OFF
private void logIOException(IOException aEx)
{
String[] args = null;
String key = "general.fileNotFound";
if (!(aEx instanceof FileNotFoundException)) {
args = new String[] {aEx.getMessage()};
key = "general.exception";
}
final LocalizedMessage message =
new LocalizedMessage(
0,
Defn.CHECKSTYLE_BUNDLE,
key,
args,
getId(),
this.getClass(), null);
getMessageCollector().add(message);
Utils.getExceptionLogger().debug("IOException occured.", aEx);
}
///CLOVER:ON
}