Package org.sonar.java.matcher

Class MethodMatchersBuilder

java.lang.Object

org.sonar.java.matcher.MethodMatchersBuilder

All Implemented Interfaces:

MethodMatchers, MethodMatchers.NameBuilder, MethodMatchers.ParametersBuilder, MethodMatchers.TypeBuilder

public class MethodMatchersBuilder
extends Object
implements MethodMatchers.TypeBuilder, MethodMatchers.NameBuilder, MethodMatchers.ParametersBuilder, MethodMatchers

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.plugins.java.api.semantic.MethodMatchers

MethodMatchers.NameBuilder, MethodMatchers.ParametersBuilder, MethodMatchers.TypeBuilder

Field Summary

Fields inherited from interface org.sonar.plugins.java.api.semantic.MethodMatchers

ANY, CONSTRUCTOR

Constructor Summary

Constructors

Constructor	Description
MethodMatchersBuilder()

Method Summary

Modifier and Type	Method	Description
MethodMatchers.ParametersBuilder	addParametersMatcher(String... parametersType)	Match a method signature with exactly the types provided.
MethodMatchers.ParametersBuilder	addParametersMatcher(Predicate<List<Type>> parametersPredicate)	Match a method signature respecting the predicate.
MethodMatchers.ParametersBuilder	addWithoutParametersMatcher()	Match a method signature without parameters.
MethodMatchers.ParametersBuilder	anyName()	Match a method with any name.
MethodMatchers	build()	Build a MethodMatchers.
MethodMatchers.ParametersBuilder	constructor()	Match a constructor.
boolean	matches(Symbol symbol)
boolean	matches(MethodInvocationTree mit)
boolean	matches(MethodReferenceTree methodReferenceTree)
boolean	matches(MethodTree methodTree)
boolean	matches(NewClassTree newClassTree)
MethodMatchers.ParametersBuilder	name(Predicate<String> namePredicate)	Match the name matching the predicate.
MethodMatchers.ParametersBuilder	names(String... names)	Match a method with any name is the list.
MethodMatchers.NameBuilder	ofAnyType()	Match any type.
MethodMatchers.NameBuilder	ofSubTypes(String... fullyQualifiedTypeNames)	Match any of the type and sub-type of the fully qualified names.
MethodMatchers.NameBuilder	ofType(Predicate<Type> typePredicate)	Match a type matching a predicate.
MethodMatchers.NameBuilder	ofTypes(String... fullyQualifiedTypeNames)	Match any of the fully qualified name types, but not the subtype.
MethodMatchers.ParametersBuilder	withAnyParameters()	Match a method signature with any number of parameters of any types.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodMatchersBuilder

public MethodMatchersBuilder()

Method Detail

ofSubTypes

public MethodMatchers.NameBuilder ofSubTypes(String... fullyQualifiedTypeNames)

Description copied from interface: MethodMatchers.TypeBuilder

Match any of the type and sub-type of the fully qualified names.

Specified by:

ofSubTypes in interface MethodMatchers.TypeBuilder

ofAnyType

public MethodMatchers.NameBuilder ofAnyType()

Description copied from interface: MethodMatchers.TypeBuilder

Match any type.

Specified by:

ofAnyType in interface MethodMatchers.TypeBuilder

ofTypes

public MethodMatchers.NameBuilder ofTypes(String... fullyQualifiedTypeNames)

Description copied from interface: MethodMatchers.TypeBuilder

Match any of the fully qualified name types, but not the subtype.

Specified by:

ofTypes in interface MethodMatchers.TypeBuilder

ofType

public MethodMatchers.NameBuilder ofType(Predicate<Type> typePredicate)

Description copied from interface: MethodMatchers.TypeBuilder

Match a type matching a predicate.

Specified by:

ofType in interface MethodMatchers.TypeBuilder

names

public MethodMatchers.ParametersBuilder names(String... names)

Description copied from interface: MethodMatchers.NameBuilder

Match a method with any name is the list.

Specified by:

names in interface MethodMatchers.NameBuilder

anyName

public MethodMatchers.ParametersBuilder anyName()

Description copied from interface: MethodMatchers.NameBuilder

Match a method with any name. Equivalent to .name(n -> true).

Specified by:

anyName in interface MethodMatchers.NameBuilder

constructor

public MethodMatchers.ParametersBuilder constructor()

Description copied from interface: MethodMatchers.NameBuilder

Match a constructor. Equivalent to .name(n -> "".equals(n))

Specified by:

constructor in interface MethodMatchers.NameBuilder

name

public MethodMatchers.ParametersBuilder name(Predicate<String> namePredicate)

Description copied from interface: MethodMatchers.NameBuilder

Match the name matching the predicate.

Specified by:

name in interface MethodMatchers.NameBuilder

addParametersMatcher

public MethodMatchers.ParametersBuilder addParametersMatcher(String... parametersType)

Description copied from interface: MethodMatchers.ParametersBuilder

Match a method signature with exactly the types provided. Others method adding parameters matcher can be called to match multiples signatures.

Specified by:

addParametersMatcher in interface MethodMatchers.ParametersBuilder

addWithoutParametersMatcher

public MethodMatchers.ParametersBuilder addWithoutParametersMatcher()

Description copied from interface: MethodMatchers.ParametersBuilder

Match a method signature without parameters. Others method adding parameters matcher can be called to match multiples signatures.

Specified by:

addWithoutParametersMatcher in interface MethodMatchers.ParametersBuilder

withAnyParameters

public MethodMatchers.ParametersBuilder withAnyParameters()

Description copied from interface: MethodMatchers.ParametersBuilder

Match a method signature with any number of parameters of any types. Others method adding parameters matchers can not be called with this method.

Specified by:

withAnyParameters in interface MethodMatchers.ParametersBuilder

addParametersMatcher

public MethodMatchers.ParametersBuilder addParametersMatcher(Predicate<List<Type>> parametersPredicate)

Description copied from interface: MethodMatchers.ParametersBuilder

Match a method signature respecting the predicate. Others method adding parameters matcher can be called to match multiples signatures.

Specified by:

addParametersMatcher in interface MethodMatchers.ParametersBuilder

matches

public boolean matches(NewClassTree newClassTree)

Specified by:

matches in interface MethodMatchers

matches

public boolean matches(MethodInvocationTree mit)

Specified by:

matches in interface MethodMatchers

matches

public boolean matches(MethodTree methodTree)

Specified by:

matches in interface MethodMatchers

matches

public boolean matches(MethodReferenceTree methodReferenceTree)

Specified by:

matches in interface MethodMatchers

matches

public boolean matches(Symbol symbol)

Specified by:

matches in interface MethodMatchers

build

public MethodMatchers build()

Description copied from interface: MethodMatchers.ParametersBuilder

Build a MethodMatchers. Throw an Exception if the MethodMatchers is not correctly setup (no parameters list defined).

Specified by:

build in interface MethodMatchers.ParametersBuilder