com.thomasjensen.checkstyle.addons.util

Class Util

java.lang.Object

com.thomasjensen.checkstyle.addons.util.Util

public final class Util
extends java.lang.Object

Utility class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	NEVER_MATCH A pattern that never matches (and does so efficiently)
static java.nio.charset.Charset	UTF8 Constant for UTF-8 charset; can be replaced with StandardCharsets.UTF_8 after moving to Java 7

Method Summary

Modifier and Type	Method and Description
static java.io.File	canonize(java.io.File pFile) Calls getCanonicalFile() on the given File; if that doesn't work, call getAbsoluteFile() on it.
static void	closeQuietly(java.io.Closeable pCloseable) Quietly close the given resource, ignoring any exceptions.
static boolean	containsString(java.lang.Iterable<java.lang.String> pIterable, java.lang.String pSearched, boolean pCaseSensitive) Search for a String in a collection.
static com.puppycrawl.tools.checkstyle.api.DetailAST	findLeftMostTokenInLine(com.puppycrawl.tools.checkstyle.api.DetailAST pAst) Find the left-most token in the given AST.
static java.lang.String	getFirstIdent(com.puppycrawl.tools.checkstyle.api.DetailAST pAst) Determine the text of the first direct IDENT child node.
static java.lang.String	getFullIdent(com.puppycrawl.tools.checkstyle.api.DetailAST pAst) Determine the full identifier of the current element on the AST.
static byte[]	readBytes(java.io.InputStream pInputStream) Read all bytes from an InputStream into a byte array.
static java.lang.String	standardizeSlashes(java.lang.String pPath) Standardizes all slashes and backslashes in the given String to File.separatorChar.
static boolean	stringEquals(java.lang.String pStr1, java.lang.String pStr2, boolean pCaseSensitive) Determine the equality of two Strings, optionally ignoring case.
static <E> java.util.Set<E>	union(java.util.Set<E> pColl1, java.util.Set<E> pColl2) Creates a new immutable HashSet which contains a union of the two given sets.
static <E extends java.lang.Enum<E>> E	valueOfIgnoreCase(java.lang.String pValue, java.lang.Class<E> pEnumClass) Variant of Enum.valueOf(java.lang.Class<T>, java.lang.String) that ignores value case.

Methods inherited from class java.lang.Object

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

Field Detail

NEVER_MATCH

public static final java.util.regex.Pattern NEVER_MATCH

A pattern that never matches (and does so efficiently)

UTF8

public static final java.nio.charset.Charset UTF8

Constant for UTF-8 charset; can be replaced with StandardCharsets.UTF_8 after moving to Java 7

Method Detail

canonize

@Nonnull
public static java.io.File canonize(@Nonnull
                                              java.io.File pFile)

Calls getCanonicalFile() on the given File; if that doesn't work, call getAbsoluteFile() on it. Thus, the resulting file is not guaranteed to exist. Separator characters are standardized to File.separatorChar.

Parameters:

pFile - a file

Returns:

the canonical representation, or the absolute representation

closeQuietly

public static void closeQuietly(@Nullable
                                java.io.Closeable pCloseable)

Quietly close the given resource, ignoring any exceptions.

Parameters:

pCloseable - the resource to close

containsString

public static boolean containsString(@Nullable
                                     java.lang.Iterable<java.lang.String> pIterable,
                                     @Nullable
                                     java.lang.String pSearched,
                                     boolean pCaseSensitive)

Search for a String in a collection.

Parameters:

pIterable - the list of String to be searched

pSearched - the String to search for

pCaseSensitive - if comparisons should be case sensitive

Returns:

true if found, false otherwise

findLeftMostTokenInLine

@Nonnull
public static com.puppycrawl.tools.checkstyle.api.DetailAST findLeftMostTokenInLine(@Nonnull
                                                                                              com.puppycrawl.tools.checkstyle.api.DetailAST pAst)

Find the left-most token in the given AST. The left-most token is the token with the smallest column number. Only tokens which are located on the same line as the given AST are considered.

Parameters:

pAst - the root of a subtree. This token is also considered for the result.

Returns:

the left-most token

getFirstIdent

@CheckForNull
public static java.lang.String getFirstIdent(@Nonnull
                                                            com.puppycrawl.tools.checkstyle.api.DetailAST pAst)

Determine the text of the first direct IDENT child node.

Parameters:

pAst - an AST

Returns:

the first encountered IDENT text, or null if none was found

getFullIdent

@CheckForNull
public static java.lang.String getFullIdent(@Nonnull
                                                           com.puppycrawl.tools.checkstyle.api.DetailAST pAst)

Determine the full identifier of the current element on the AST. The identifier is built from DOT and IDENT elements found directly below the specified element. Other elements encountered are ignored.

Parameters:

pAst - an AST

Returns:

the full identifier constructed from either the first encountered IDENT or DOT; null if no identifier could be constructed

readBytes

public static byte[] readBytes(@Nonnull
                               java.io.InputStream pInputStream)
                        throws java.io.IOException

Read all bytes from an InputStream into a byte array. Can be replaced with Files.readAllBytes() once the code is migrated to Java 7.

Parameters:

pInputStream - the input stream

Returns:

the complete contents read from the input stream

Throws:

java.io.IOException - I/O error

standardizeSlashes

@Nonnull
public static java.lang.String standardizeSlashes(@Nonnull
                                                            java.lang.String pPath)

Standardizes all slashes and backslashes in the given String to File.separatorChar.

Parameters:

pPath - a String

Returns:

a new String which is pPath with standardized path separator characters

stringEquals

public static boolean stringEquals(@Nullable
                                   java.lang.String pStr1,
                                   @Nullable
                                   java.lang.String pStr2,
                                   boolean pCaseSensitive)

Determine the equality of two Strings, optionally ignoring case.

Parameters:

pStr1 - the first String

pStr2 - the second String

pCaseSensitive - if the comparison should be case sensitive

Returns:

true if the String are equal, false otherwise

union

@Nonnull
public static <E> java.util.Set<E> union(@Nullable
                                                   java.util.Set<E> pColl1,
                                                   @Nullable
                                                   java.util.Set<E> pColl2)

Creates a new immutable HashSet which contains a union of the two given sets.

Type Parameters:

E - type of all contained elements

Parameters:

pColl1 - first set

pColl2 - second set

Returns:

union set

valueOfIgnoreCase

@Nonnull
public static <E extends java.lang.Enum<E>> E valueOfIgnoreCase(@Nonnull
                                                                          java.lang.String pValue,
                                                                          @Nonnull
                                                                          java.lang.Class<E> pEnumClass)

Variant of Enum.valueOf(java.lang.Class<T>, java.lang.String) that ignores value case.

Type Parameters:

E - the enum type

Parameters:

pValue - the String value

pEnumClass - the class object of the enum type

Returns:

the enum value

Throws:

java.lang.IllegalArgumentException - the given String value does not match a valid enum value