eu.cqse.check.framework.util

Class JavaLanguageFeatureParser

java.lang.Object

eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase

eu.cqse.check.framework.util.JavaLanguageFeatureParser

All Implemented Interfaces:

ILanguageFeatureParser

public class JavaLanguageFeatureParser
extends CLikeLanguageFeatureParserBase

Language feature parser for Java.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<ETokenType>	ADDITIONAL_TYPE_TOKENS All token types that can be used to specify a non primitive type.
static java.util.EnumSet<ETokenType>	PRIMITIVE_TYPE_TOKENS All token types that can be used to specify a primitive type.
static java.util.EnumSet<ETokenType>	VALID_IDENTIFIERS All token types that can be used as identifier.

Fields inherited from class eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase

CONDITIONAL_OPERATOR_TYPES, packageSeparator, packageSeparatorText, POINTER_TYPES, primitiveTypeTokens, TYPE_MODIFICATIONS, typeTokens, useExtractor, validIdentifiers, variableSplitType

Constructor Summary

Constructors

Constructor and Description
JavaLanguageFeatureParser() Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<IToken>	filterGenericTokens(java.util.List<IToken> genericTokens) Filters the generic tokens before converting them to their token texts.
java.util.List<ShallowEntity>	getAnnotations(ShallowEntity entity) Returns all annotation entities that annotate the given entity.
java.util.List<ShallowEntity>	getAnnotations(ShallowEntity entity, boolean includeParentEntities) Returns all annotation entities that annotate the given entity.
java.lang.String	getDetailedReturnType(ShallowEntity entity) Get the detailed return type of a method.
java.lang.String	getImportName(ShallowEntity entity) Returns the imported package name from a given "import" entity.
java.util.List<java.util.List<IToken>>	getThrownTypesTokens(ShallowEntity methodEntity) Returns all token lists representing thrown types of a method in the order of declaration.
IToken	getThrowsToken(ShallowEntity methodEntity) Returns the token of the throws keyword of a given method.
boolean	isAnnotated(ShallowEntity entity) Returns if the entity has at least one annotation.
boolean	isAnnotation(ShallowEntity entity) Returns whether the given entity is an annotation.
boolean	isConstant(ShallowEntity entity) Returns whether the given entity is a constant.
boolean	isForEachLoop(ShallowEntity entity) Returns whether the given entity is a for each loop.
boolean	isGenericExceptionClass(java.lang.String className) Determines whether the given class name represents a generic exception.
boolean	isImport(ShallowEntity entity) Returns whether the given entity is an import (including static imports).

Methods inherited from class eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase

collectTokenFromTypePart, collectTokensFromModifiers, collectTokensFromPointers, collectTokensFromPrimitiveType, collectTokensFromType, collectTokensFromTypeAndModifications, extractConditionTokens, extractParameterTokens, getBaseTypeName, getGenericNamesForMethod, getGenericNamesForType, getGenericTypeNames, getImportedNames, getLanguage, getMethodOpeningParenthesisIndex, getModifiersAndTypeFromTokens, getParameterTokens, getParameterTypeNames, getPlainTypeName, getReturnType, getSplitParameterTokens, getTypeNameFromCatchTokens, getTypeNameStartIndex, getVariableNameFromCatchTokens, getVariableNameFromTokens, getVariableNamesFromTokens, getVariableReadsFromTokens, getVariableTokensFromForLikeTokens, getVariableTypeFromTokens, getVariableUsesFromTokens, getVariableWritesFromTokens, hasOnlyStaticMembers, hasVariableLengthArgumentList, hasVoidReturnType, isPrimitiveTypeToken, isStatic, isTypeToken, isVariableDeclaration, matchesFullQualifiedTypeName, reverseSkipToType, skipGeneric, skipGenericReverse, splitVariableTokens

Methods inherited from class java.lang.Object

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

Field Detail

ADDITIONAL_TYPE_TOKENS

public static final java.util.EnumSet<ETokenType> ADDITIONAL_TYPE_TOKENS

All token types that can be used to specify a non primitive type.

PRIMITIVE_TYPE_TOKENS

public static final java.util.EnumSet<ETokenType> PRIMITIVE_TYPE_TOKENS

All token types that can be used to specify a primitive type.

VALID_IDENTIFIERS

public static final java.util.EnumSet<ETokenType> VALID_IDENTIFIERS

All token types that can be used as identifier.

Constructor Detail

JavaLanguageFeatureParser

public JavaLanguageFeatureParser()

Constructor.

Method Detail

getImportName

public java.lang.String getImportName(ShallowEntity entity)

Returns the imported package name from a given "import" entity. Static imports are ignored.

Specified by:

getImportName in class CLikeLanguageFeatureParserBase

isImport

public boolean isImport(ShallowEntity entity)

Returns whether the given entity is an import (including static imports).

Specified by:

isImport in class CLikeLanguageFeatureParserBase

isConstant

public boolean isConstant(ShallowEntity entity)

Returns whether the given entity is a constant.

isForEachLoop

public boolean isForEachLoop(ShallowEntity entity)

Returns whether the given entity is a for each loop.

isAnnotation

public boolean isAnnotation(ShallowEntity entity)

Returns whether the given entity is an annotation.

getAnnotations

public java.util.List<ShallowEntity> getAnnotations(ShallowEntity entity)

Returns all annotation entities that annotate the given entity.

getAnnotations

public java.util.List<ShallowEntity> getAnnotations(ShallowEntity entity,
                                                    boolean includeParentEntities)

Returns all annotation entities that annotate the given entity.

getThrownTypesTokens

public java.util.List<java.util.List<IToken>> getThrownTypesTokens(ShallowEntity methodEntity)

Returns all token lists representing thrown types of a method in the order of declaration.

getThrowsToken

public IToken getThrowsToken(ShallowEntity methodEntity)

Returns the token of the throws keyword of a given method. If no throws keyword is found null is returned.

isAnnotated

public boolean isAnnotated(ShallowEntity entity)

Returns if the entity has at least one annotation.

getDetailedReturnType

public java.lang.String getDetailedReturnType(ShallowEntity entity)

Get the detailed return type of a method. The detailed return type includes the type name and array and generic declarations.

isGenericExceptionClass

public boolean isGenericExceptionClass(java.lang.String className)

Determines whether the given class name represents a generic exception.

filterGenericTokens

protected java.util.List<IToken> filterGenericTokens(java.util.List<IToken> genericTokens)

Description copied from class: CLikeLanguageFeatureParserBase

Filters the generic tokens before converting them to their token texts. The default implementation doesn't do any filtering.

Overrides:

filterGenericTokens in class CLikeLanguageFeatureParserBase