com.puppycrawl.tools.checkstyle.api
public final class Utils extends Object
Version: 1.0
Method Summary | |
---|---|
static String | baseClassname(String aType) |
static Pattern | createPattern(String aPattern)
Helper method to create a regular expression. |
static Log | getExceptionLogger()
Accessor for shared instance of logger which should be
used to log all exceptions occured during FileSetCheck
work (debug() should be used). |
static String[] | getLines(String aFileName)
Loads the contents of a file in a String array. |
static String[] | getLines(String aFileName, String aCharsetName)
Loads the contents of a file in a String array using
the named charset. |
static Pattern | getPattern(String aPattern)
This is a factory method to return an Pattern object for the specified
regular expression. |
static String | getStrippedFileName(String aBasedir, String aFileName)
Create a stripped down version of a filename. |
static int | lengthExpandedTabs(String aString, int aToIdx, int aTabWidth)
Returns the length of a String prefix with tabs expanded.
|
static int | lengthMinusTrailingWhitespace(String aLine)
Returns the length of a string ignoring all trailing whitespace. |
static boolean | whitespaceBefore(int aIndex, String aLine)
Returns whether the specified string contains only whitespace up to the
specified index.
|
Parameters: aType the fully qualified name. Cannot be null
Returns: the base class name from a fully qualified name
Parameters: aPattern the pattern to match
Returns: a created regexp object
Throws: ConversionException if unable to create Pattern object.
FileSetCheck
work (debug()
should be used).Returns: shared exception logger.
Parameters: aFileName the name of the file to load
Returns: the lines in the file
Throws: IOException error occurred
Parameters: aFileName the name of the file to load aCharsetName the name of a supported charset
Returns: the lines in the file
Throws: IOException error occurred
Parameters: aPattern the regular expression pattern
Returns: an Pattern object for the supplied pattern
Throws: PatternSyntaxException an invalid pattern was supplied
Parameters: aBasedir the prefix to strip off the original filename aFileName the original filename
Returns: the filename where an initial prefix of basedir is stripped
Parameters: aString the input String aToIdx index in aString (exclusive) where the calculation stops aTabWidth the distance betweeen tab stop position.
Returns: the length of aString.substring(0, aToIdx) with tabs expanded.
Parameters: aLine the string to process
Returns: the length of the string ignoring all trailing whitespace
Parameters: aIndex index to check up to aLine the line to check
Returns: whether there is only whitespace