com.thomasjensen.checkstyle.addons.util

Class Util

java.lang.Object

com.thomasjensen.checkstyle.addons.util.Util

public final class Util
extends Object

Utility class.

Author:

Thomas Jensen

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	NEVER_MATCH A pattern that never matches (and does so efficiently)

Method Summary

Methods

Modifier and Type	Method and Description
static File	canonize(File pFile) Calls getCanonicalFile() on the given File; if that doesn't work, call getAbsoluteFile() on it.
static void	closeQuietly(Closeable pCloseable) Quietly close the given resource, ignoring any exceptions.
static DetailAST	findLeftMostTokenInLine(DetailAST pAst) Find the left-most token in the given AST.
static String	getFirstIdent(DetailAST pAst) Determine the text of the first direct IDENT child node.
static String	getFullIdent(DetailAST pAst) Determine the full identifier of the current element on the AST.
static <E> Set<E>	union(Set<E> pColl1, Set<E> pColl2) Creates a new immutable HashSet which contains a union of the two given sets.
static <E extends Enum<E>> E	valueOfIgnoreCase(String pValue, 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 Pattern NEVER_MATCH

A pattern that never matches (and does so efficiently)

Method Detail

getFirstIdent

@CheckForNull
public static String getFirstIdent(@Nonnull
                                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 String getFullIdent(@Nonnull
                               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

closeQuietly

public static void closeQuietly(@Nullable
                Closeable pCloseable)

Quietly close the given resource, ignoring any exceptions.

Parameters:

pCloseable - the resource to close

canonize

@Nonnull
public static File canonize(@Nonnull
                    File pFile)

Calls getCanonicalFile() on the given File; if that doesn't work, call getAbsoluteFile() on it.

Parameters:

pFile - a file

Returns:

the canonical representation, or the absolute representation

union

@Nonnull
public static <E> Set<E> union(@Nullable
                       Set<E> pColl1,
                       @Nullable
                       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

findLeftMostTokenInLine

@Nonnull
public static DetailAST findLeftMostTokenInLine(@Nonnull
                                        DetailAST pAst)

Find the left-most token in the given AST. The left-most token is the token with the smallest column number. Only token 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

valueOfIgnoreCase

@Nonnull
public static <E extends Enum<E>> E valueOfIgnoreCase(@Nonnull
                                              String pValue,
                                              @Nonnull
                                              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:

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