com.puppycrawl.tools.checkstyle.api

Class Utils

java.lang.Object

com.puppycrawl.tools.checkstyle.api.Utils

public final class Utils
extends Object

Contains utility methods.

Version:

1.0

Author:

Oliver Burn

Method Summary

Methods

Modifier and Type	Method and Description
static String	baseClassname(String type)
static void	closeQuietly(Closeable shutting) Closes the supplied Closeable object ignoring an IOException if it is thrown.
static Pattern	createPattern(String pattern) Helper method to create a regular expression.
static org.apache.commons.logging.Log	getExceptionLogger() Accessor for shared instance of logger which should be used to log all exceptions occurred during FileSetCheck work (debug() should be used).
static String[]	getLines(String fileName) Deprecated. consider using FileText instead
static String[]	getLines(String fileName, String charsetName) Deprecated. consider using FileText instead
static Pattern	getPattern(String pattern) This is a factory method to return an Pattern object for the specified regular expression.
static Pattern	getPattern(String pattern, int compileFlags) This is a factory method to return an Pattern object for the specified regular expression and compile flags.
static String	getStrippedFileName(String basedir, String fileName) Create a stripped down version of a filename.
static int	lengthExpandedTabs(String string, int toIdx, int tabWidth) Returns the length of a String prefix with tabs expanded.
static int	lengthMinusTrailingWhitespace(String line) Returns the length of a string ignoring all trailing whitespace.
static boolean	whitespaceBefore(int index, String line) Returns whether the specified string contains only whitespace up to the specified index.

Methods inherited from class java.lang.Object

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

Method Detail

getExceptionLogger

public static org.apache.commons.logging.Log getExceptionLogger()

Accessor for shared instance of logger which should be used to log all exceptions occurred during FileSetCheck work (debug() should be used).

Returns:

shared exception logger.

whitespaceBefore

public static boolean whitespaceBefore(int index,
                       String line)

Returns whether the specified string contains only whitespace up to the specified index.

Parameters:

index - index to check up to

line - the line to check

Returns:

whether there is only whitespace

lengthMinusTrailingWhitespace

public static int lengthMinusTrailingWhitespace(String line)

Returns the length of a string ignoring all trailing whitespace. It is a pity that there is not a trim() like method that only removed the trailing whitespace.

Parameters:

line - the string to process

Returns:

the length of the string ignoring all trailing whitespace

lengthExpandedTabs

public static int lengthExpandedTabs(String string,
                     int toIdx,
                     int tabWidth)

Returns the length of a String prefix with tabs expanded. Each tab is counted as the number of characters is takes to jump to the next tab stop.

Parameters:

string - the input String

toIdx - index in string (exclusive) where the calculation stops

tabWidth - the distance between tab stop position.

Returns:

the length of string.substring(0, toIdx) with tabs expanded.

getPattern

public static Pattern getPattern(String pattern)
                          throws PatternSyntaxException

This is a factory method to return an Pattern object for the specified regular expression. It calls getPattern(String, int) with the compile flags defaults to 0.

Parameters:

pattern - the regular expression pattern

Returns:

an Pattern object for the supplied pattern

Throws:

PatternSyntaxException - an invalid pattern was supplied

getPattern

public static Pattern getPattern(String pattern,
                 int compileFlags)
                          throws PatternSyntaxException

This is a factory method to return an Pattern object for the specified regular expression and compile flags.

Parameters:

pattern - the regular expression pattern

compileFlags - the compilation flags

Returns:

an Pattern object for the supplied pattern

Throws:

PatternSyntaxException - an invalid pattern was supplied

getLines

@Deprecated
public static String[] getLines(String fileName)
                         throws IOException

Deprecated. consider using FileText instead

Loads the contents of a file in a String array.

Parameters:

fileName - the name of the file to load

Returns:

the lines in the file

Throws:

IOException - error occurred

getLines

@Deprecated
public static String[] getLines(String fileName,
                           String charsetName)
                         throws IOException

Deprecated. consider using FileText instead

Loads the contents of a file in a String array using the named charset.

Parameters:

fileName - the name of the file to load

charsetName - the name of a supported charset

Returns:

the lines in the file

Throws:

IOException - error occurred

createPattern

public static Pattern createPattern(String pattern)
                             throws org.apache.commons.beanutils.ConversionException

Helper method to create a regular expression.

Parameters:

pattern - the pattern to match

Returns:

a created regexp object

Throws:

org.apache.commons.beanutils.ConversionException - if unable to create Pattern object.

baseClassname

public static String baseClassname(String type)

Parameters:

type - the fully qualified name. Cannot be null

Returns:

the base class name from a fully qualified name

getStrippedFileName

public static String getStrippedFileName(String basedir,
                         String fileName)

Create a stripped down version of a filename.

Parameters:

basedir - the prefix to strip off the original filename

fileName - the original filename

Returns:

the filename where an initial prefix of basedir is stripped

closeQuietly

public static void closeQuietly(Closeable shutting)

Closes the supplied Closeable object ignoring an IOException if it is thrown. Honestly, what are you going to do if you cannot close a file.

Parameters:

shutting - the object to be closed.