eu.cqse.check.framework.shallowparser.util

Class EntitySelectionPredicates

java.lang.Object

eu.cqse.check.framework.shallowparser.util.EntitySelectionPredicates

public class EntitySelectionPredicates
extends java.lang.Object

Defines valid primitive expressions that can be used in the EntitySelectionExpressionParser. Each expression is defined by a public static method of same name. Methods found here must be parameterless or accept a single string parameter and must return an Predicate over ShallowEntity. To avoid clashes with Java keywords, an optional prefix "select" may be used. Note that the comments for the public methods describe not exactly the function, but rather the returned predicate.

Constructor Summary

Constructors

Constructor and Description
EntitySelectionPredicates()

Method Summary

Modifier and Type	Method and Description
static java.util.function.Predicate<ShallowEntity>	annotated(java.lang.String annotationName) Matches all entities that are annotated with an annotation of given name (excluding the '@' sign).
static java.util.function.Predicate<ShallowEntity>	attribute() Selects all attributes.
static java.util.function.Predicate<ShallowEntity>	declaration() Selects all shallow entities whose subtype is a declaration.
static java.util.function.Predicate<ShallowEntity>	export() Matches all export entities.
static java.util.function.Predicate<ShallowEntity>	fileRegex(java.lang.String regex) Matches entities by their file name
static java.util.function.Predicate<ShallowEntity>	internal() Selects all shallow entities that are internal (C# keyword).
static java.util.function.Predicate<ShallowEntity>	isAbstract()
static java.util.function.Predicate<ShallowEntity>	language(java.lang.String languageName) Selects entities in files with the given language.
static java.util.function.Predicate<ShallowEntity>	meta() Selects all meta information (defines, annotations, etc.).
static java.util.function.Predicate<ShallowEntity>	method() Selects all methods/functions.
static java.util.function.Predicate<ShallowEntity>	module() Selects all modules/namespaces.
static java.util.function.Predicate<ShallowEntity>	name(java.lang.String name) Matches entities by their name.
static java.util.function.Predicate<ShallowEntity>	nameRegex(java.lang.String regex) Matches entities by their name using regular expression.
static java.util.function.Predicate<ShallowEntity>	primitive() Matches all primitive entities (i.e.
static java.util.function.Predicate<ShallowEntity>	property() Selects all properties, defined attributes that have only method children.
static java.util.function.Predicate<ShallowEntity>	selectDefault() Matches all entities with default visibility.
static java.util.function.Predicate<ShallowEntity>	selectFinal() Matches all final entities.
static java.util.function.Predicate<ShallowEntity>	selectOverride() Matches all entities marked with override.
static java.util.function.Predicate<ShallowEntity>	selectPrivate() Matches all private entities (except the TypeScript constructor parameters).
static java.util.function.Predicate<ShallowEntity>	selectProtected() Matches all protected entities.
static java.util.function.Predicate<ShallowEntity>	selectPublic() Matches all public entities as well as methods inside interfaces, which are considered public in most languages.
static java.util.function.Predicate<ShallowEntity>	selectStatic() Matches all static entities.
static java.util.function.Predicate<ShallowEntity>	simpleCSharpGetter() Matches getter in CSharp generated by the automatic property generation feature.
static java.util.function.Predicate<ShallowEntity>	simpleCSharpSetter() Matches setter in CSharp generated by the automatic property generation feature.
static java.util.function.Predicate<ShallowEntity>	simpleGetter() Matches simple getters, i.e.
static java.util.function.Predicate<ShallowEntity>	simpleGetterCaseInsensitive() Matches simple getters, i.e.
static java.util.function.Predicate<ShallowEntity>	simpleMethod(java.lang.String namePrefix) Matches simple methods with the given prefix.
static java.util.function.Predicate<ShallowEntity>	simpleMethodCaseInsensitive(java.lang.String namePrefix) Matches simple methods with the given prefix (case insensitive).
static java.util.function.Predicate<ShallowEntity>	simpleSetter() Matches simple setters, i.e.
static java.util.function.Predicate<ShallowEntity>	simpleSetterCaseInsensitive() Matches simple setters, i.e.
static java.util.function.Predicate<ShallowEntity>	statement() Selects all statements.
static java.util.function.Predicate<ShallowEntity>	subtype(java.lang.String subtype) Matches entities by their subtype.
static java.util.function.Predicate<ShallowEntity>	type() Selects all types/classes.
static java.util.function.Predicate<ShallowEntity>	typeExported() Matches entities whose parent is an exported type.
static java.util.function.Predicate<ShallowEntity>	typeSubtype(java.lang.String subtype) Matches entities by their parent type's subtype (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntitySelectionPredicates

public EntitySelectionPredicates()

Method Detail

language

public static java.util.function.Predicate<ShallowEntity> language(java.lang.String languageName)

Selects entities in files with the given language. If the given language name is invalid, no entities are matched.

module

public static java.util.function.Predicate<ShallowEntity> module()

Selects all modules/namespaces.

type

public static java.util.function.Predicate<ShallowEntity> type()

Selects all types/classes.

method

public static java.util.function.Predicate<ShallowEntity> method()

Selects all methods/functions.

declaration

public static java.util.function.Predicate<ShallowEntity> declaration()

Selects all shallow entities whose subtype is a declaration.

internal

public static java.util.function.Predicate<ShallowEntity> internal()

Selects all shallow entities that are internal (C# keyword).

attribute

public static java.util.function.Predicate<ShallowEntity> attribute()

Selects all attributes.

property

public static java.util.function.Predicate<ShallowEntity> property()

Selects all properties, defined attributes that have only method children. More specific: ATTRIBUTE entities that have children and each child is a METHOD entity. E.g., C# properties.

statement

public static java.util.function.Predicate<ShallowEntity> statement()

Selects all statements.

meta

public static java.util.function.Predicate<ShallowEntity> meta()

Selects all meta information (defines, annotations, etc.).

selectPublic

public static java.util.function.Predicate<ShallowEntity> selectPublic()

Matches all public entities as well as methods inside interfaces, which are considered public in most languages.

isAbstract

public static java.util.function.Predicate<ShallowEntity> isAbstract()

selectProtected

public static java.util.function.Predicate<ShallowEntity> selectProtected()

Matches all protected entities.

selectOverride

public static java.util.function.Predicate<ShallowEntity> selectOverride()

Matches all entities marked with override.

selectPrivate

public static java.util.function.Predicate<ShallowEntity> selectPrivate()

Matches all private entities (except the TypeScript constructor parameters).

selectDefault

public static java.util.function.Predicate<ShallowEntity> selectDefault()

Matches all entities with default visibility.

selectFinal

public static java.util.function.Predicate<ShallowEntity> selectFinal()

Matches all final entities.

selectStatic

public static java.util.function.Predicate<ShallowEntity> selectStatic()

Matches all static entities.

export

public static java.util.function.Predicate<ShallowEntity> export()

Matches all export entities.

primitive

public static java.util.function.Predicate<ShallowEntity> primitive()

Matches all primitive entities (i.e. those without children).

subtype

public static java.util.function.Predicate<ShallowEntity> subtype(java.lang.String subtype)

Matches entities by their subtype.

typeSubtype

public static java.util.function.Predicate<ShallowEntity> typeSubtype(java.lang.String subtype)

Matches entities by their parent type's subtype (e.g. to select all members of interfaces).

typeExported

public static java.util.function.Predicate<ShallowEntity> typeExported()

Matches entities whose parent is an exported type.

name

public static java.util.function.Predicate<ShallowEntity> name(java.lang.String name)

Matches entities by their name.

nameRegex

public static java.util.function.Predicate<ShallowEntity> nameRegex(java.lang.String regex)

Matches entities by their name using regular expression.

fileRegex

public static java.util.function.Predicate<ShallowEntity> fileRegex(java.lang.String regex)

Matches entities by their file name

annotated

public static java.util.function.Predicate<ShallowEntity> annotated(java.lang.String annotationName)

Matches all entities that are annotated with an annotation of given name (excluding the '@' sign).

simpleGetter

public static java.util.function.Predicate<ShallowEntity> simpleGetter()

Matches simple getters, i.e. methods starting with "get" or "is" and with at most one contained statement.

simpleSetter

public static java.util.function.Predicate<ShallowEntity> simpleSetter()

Matches simple setters, i.e. methods starting with "set" and with at most one contained statement.

simpleSetterCaseInsensitive

public static java.util.function.Predicate<ShallowEntity> simpleSetterCaseInsensitive()

Matches simple setters, i.e. methods starting with "set" (case insensitive) and with at most one contained statement.

simpleGetterCaseInsensitive

public static java.util.function.Predicate<ShallowEntity> simpleGetterCaseInsensitive()

Matches simple getters, i.e. methods starting with "get" or "is" (case insensitive) and with at most one contained statement.

simpleCSharpGetter

public static java.util.function.Predicate<ShallowEntity> simpleCSharpGetter()

Matches getter in CSharp generated by the automatic property generation feature. These are recognized by the entity subtype '(empty) get'

simpleCSharpSetter

public static java.util.function.Predicate<ShallowEntity> simpleCSharpSetter()

Matches setter in CSharp generated by the automatic property generation feature. These are recognized by the entity subtype '(empty) set'

simpleMethod

public static java.util.function.Predicate<ShallowEntity> simpleMethod(java.lang.String namePrefix)

Matches simple methods with the given prefix. A method is simple, if it contains as most one statement.

simpleMethodCaseInsensitive

public static java.util.function.Predicate<ShallowEntity> simpleMethodCaseInsensitive(java.lang.String namePrefix)

Matches simple methods with the given prefix (case insensitive). A method is simple, if it contains as most one statement.