com.puppycrawl.tools.checkstyle

Class Utils

java.lang.Object

com.puppycrawl.tools.checkstyle.Utils

public final class Utils
extends Object

Contains utility methods.

Author:

Aleksey Nesterenko

Method Summary

Modifier and Type	Method and Description
static String	baseClassname(String type)
static Pattern	createPattern(String pattern) Helper method to create a regular expression.
static boolean	fileExtensionMatches(File file, String[] fileExtensions) Returns whether the file extension matches what we are meant to process.
static boolean	isPatternValid(String pattern) Validates whether passed string is a valid pattern or not.
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 String	relativizeAndNormalizePath(String baseDirectory, String path) Constructs a normalized relative path between base directory and a given path.
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

fileExtensionMatches

public static boolean fileExtensionMatches(File file,
                                           String[] fileExtensions)

Returns whether the file extension matches what we are meant to process.

Parameters:

file - the file to be checked.

fileExtensions - files extensions, empty property in config makes it matches to all.

Returns:

whether there is a match.

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.

isPatternValid

public static boolean isPatternValid(String pattern)

Validates whether passed string is a valid pattern or not.

Parameters:

pattern - string to validate

Returns:

true if the pattern is valid false otherwise

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

relativizeAndNormalizePath

public static String relativizeAndNormalizePath(String baseDirectory,
                                                String path)

Constructs a normalized relative path between base directory and a given path.

Parameters:

baseDirectory - the base path to which given path is relativized

path - the path to relativize against base directory

Returns:

the relative normalized path between base directory and path or path if base directory is null