Package com.comphenix.protocol.reflect.fuzzy

Class FuzzyMethodContract.Builder

java.lang.Object

com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember.Builder<FuzzyMethodContract>

com.comphenix.protocol.reflect.fuzzy.FuzzyMethodContract.Builder

Enclosing class:

FuzzyMethodContract

public static final class FuzzyMethodContract.Builder
extends AbstractFuzzyMember.Builder<FuzzyMethodContract>

Represents a builder for a fuzzy method contract.

Field Summary

Fields inherited from class com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember.Builder

member

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FuzzyMethodContract.Builder	banModifier(int modifier)	Add a given bit-field of modifers that will skip or ignore members.
FuzzyMethodContract	build()	Build a new instance of this type.
FuzzyMethodContract.Builder	declaringClassDerivedOf(Class<?> declaringClass)	Require that a member is defined by this exact class, or any super class.
FuzzyMethodContract.Builder	declaringClassExactType(Class<?> declaringClass)	Require that a member is defined by this exact class.
FuzzyMethodContract.Builder	declaringClassMatching(AbstractFuzzyMatcher<Class<?>> classMatcher)	Require that a member is defined by a class that matches the given matcher.
FuzzyMethodContract.Builder	declaringClassSuperOf(Class<?> declaringClass)	Require that a member is defined by this exact class, or any super class.
FuzzyMethodContract.Builder	exceptionExactType(Class<?> type)	Add a throwable exception that must match the given type exactly.
FuzzyMethodContract.Builder	exceptionExactType(Class<?> type, int index)	Add a throwable exception that must match the given type exactly and index.
FuzzyMethodContract.Builder	exceptionMatches(AbstractFuzzyMatcher<Class<?>> classMatcher)	Add a throwable exception that must match the given matcher,
FuzzyMethodContract.Builder	exceptionMatches(AbstractFuzzyMatcher<Class<?>> classMatcher, int index)	Add a throwable exception that must match the given matcher and index.
FuzzyMethodContract.Builder	exceptionSuperOf(Class<?> type)	Add a throwable exception that must match the given type or be derived.
FuzzyMethodContract.Builder	exceptionSuperOf(Class<?> type, int index)	Add a throwable exception that must match the given type or be derived and index.
protected FuzzyMethodContract	initialMember()	Construct a new instance of the current type.
FuzzyMethodContract.Builder	nameExact(String name)	Set the exact name of the member we are matching.
FuzzyMethodContract.Builder	nameRegex(String regex)	Set the regular expresson that matches a members name.
FuzzyMethodContract.Builder	nameRegex(Pattern pattern)	Set the regular expression pattern that matches a members name.
FuzzyMethodContract.Builder	parameterCount(int expectedCount)	Set the expected number of parameters in the matching method.
FuzzyMethodContract.Builder	parameterDerivedOf(Class<?> type)	Add a new required parameter whose type must be a derived class of the given class.
FuzzyMethodContract.Builder	parameterDerivedOf(Class<?> type, int index)	Add a new required parameter whose type must be a derived class of the given class.
FuzzyMethodContract.Builder	parameterExactArray(Class<?>... types)	Add a new required parameters by type and order for any matching method.
FuzzyMethodContract.Builder	parameterExactType(Class<?> type)	Add a new required parameter by type for any matching method.
FuzzyMethodContract.Builder	parameterExactType(Class<?> type, int index)	Add a new required parameter by type and position for any matching method.
FuzzyMethodContract.Builder	parameterMatches(AbstractFuzzyMatcher<Class<?>> classMatcher)	Add a new required parameter whose type must match the given class matcher.
FuzzyMethodContract.Builder	parameterMatches(AbstractFuzzyMatcher<Class<?>> classMatcher, int index)	Add a new required parameter whose type must match the given class matcher and index.
FuzzyMethodContract.Builder	parameterSuperOf(Class<?> type)	Add a new required parameter whose type must be a superclass of the given type.
FuzzyMethodContract.Builder	parameterSuperOf(Class<?> type, int index)	Add a new required parameter whose type must be a superclass of the given type.
FuzzyMethodContract.Builder	requireModifier(int modifier)	Add a given bit-field of required modifiers for every matching member.
FuzzyMethodContract.Builder	requirePublic()	Require that every matching member is public.
FuzzyMethodContract.Builder	returnDerivedOf(Class<?> type)	Set the expected super class of the return type for every matching method.
FuzzyMethodContract.Builder	returnTypeExact(Class<?> type)	Set the return type of a matching method exactly.
FuzzyMethodContract.Builder	returnTypeMatches(AbstractFuzzyMatcher<Class<?>> classMatcher)	Set a matcher that must match the return type of a matching method.
FuzzyMethodContract.Builder	returnTypeVoid()	Require a void method.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

requireModifier

public FuzzyMethodContract.Builder requireModifier(int modifier)

Description copied from class: AbstractFuzzyMember.Builder

Add a given bit-field of required modifiers for every matching member.

Overrides:

requireModifier in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

modifier - - bit-field of modifiers that are required.

Returns:

This builder, for chaining.

requirePublic

public FuzzyMethodContract.Builder requirePublic()

Description copied from class: AbstractFuzzyMember.Builder

Require that every matching member is public.

Overrides:

requirePublic in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Returns:

This builder, for chaining.

banModifier

public FuzzyMethodContract.Builder banModifier(int modifier)

Description copied from class: AbstractFuzzyMember.Builder

Add a given bit-field of modifers that will skip or ignore members.

Overrides:

banModifier in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

modifier - - bit-field of modifiers to skip or ignore.

Returns:

This builder, for chaining.

nameRegex

public FuzzyMethodContract.Builder nameRegex(String regex)

Description copied from class: AbstractFuzzyMember.Builder

Set the regular expresson that matches a members name.

Overrides:

nameRegex in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

regex - - new regular expression of valid names.

Returns:

This builder, for chaining.

nameRegex

public FuzzyMethodContract.Builder nameRegex(Pattern pattern)

Description copied from class: AbstractFuzzyMember.Builder

Set the regular expression pattern that matches a members name.

Overrides:

nameRegex in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

pattern - - regular expression pattern for a valid name.

Returns:

This builder, for chaining.

nameExact

public FuzzyMethodContract.Builder nameExact(String name)

Description copied from class: AbstractFuzzyMember.Builder

Set the exact name of the member we are matching.

This will overwrite the regular expression rule.

Overrides:

nameExact in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

name - - exact name.

Returns:

This builder, for chaining.

declaringClassExactType

public FuzzyMethodContract.Builder declaringClassExactType(Class<?> declaringClass)

Description copied from class: AbstractFuzzyMember.Builder

Require that a member is defined by this exact class.

Overrides:

declaringClassExactType in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

declaringClass - - the declaring class of any matching member.

Returns:

This builder, for chaining.

declaringClassSuperOf

public FuzzyMethodContract.Builder declaringClassSuperOf(Class<?> declaringClass)

Description copied from class: AbstractFuzzyMember.Builder

Require that a member is defined by this exact class, or any super class.

Overrides:

declaringClassSuperOf in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

declaringClass - - the declaring class.

Returns:

This builder, for chaining.

declaringClassDerivedOf

public FuzzyMethodContract.Builder declaringClassDerivedOf(Class<?> declaringClass)

Description copied from class: AbstractFuzzyMember.Builder

Require that a member is defined by this exact class, or any super class.

Overrides:

declaringClassDerivedOf in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

declaringClass - - the declaring class.

Returns:

This builder, for chaining.

declaringClassMatching

public FuzzyMethodContract.Builder declaringClassMatching(AbstractFuzzyMatcher<Class<?>> classMatcher)

Description copied from class: AbstractFuzzyMember.Builder

Require that a member is defined by a class that matches the given matcher.

Overrides:

declaringClassMatching in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Parameters:

classMatcher - - class matcher.

Returns:

This builder, for chaining.

parameterExactType

public FuzzyMethodContract.Builder parameterExactType(Class<?> type)

Add a new required parameter by type for any matching method.

Parameters:

type - - the exact type this parameter must match.

Returns:

This builder, for chaining.

parameterSuperOf

public FuzzyMethodContract.Builder parameterSuperOf(Class<?> type)

Add a new required parameter whose type must be a superclass of the given type.

If a method parameter is of type Number, then any derived class here (Integer, Long, etc.) will match it.

Parameters:

type - - a type or less derived type of the matching parameter.

Returns:

This builder, for chaining.

parameterDerivedOf

public FuzzyMethodContract.Builder parameterDerivedOf(Class<?> type)

Add a new required parameter whose type must be a derived class of the given class.

If the method parameter has the type Integer, then the class Number here will match it.

Parameters:

type - - a type or more derived type of the matching parameter.

Returns:

This builder, for chaining.

parameterMatches

public FuzzyMethodContract.Builder parameterMatches(AbstractFuzzyMatcher<Class<?>> classMatcher)

Add a new required parameter whose type must match the given class matcher.

Parameters:

classMatcher - - the class matcher.

Returns:

This builder, for chaining.

parameterExactType

public FuzzyMethodContract.Builder parameterExactType(Class<?> type,
 int index)

Add a new required parameter by type and position for any matching method.

Parameters:

type - - the exact type this parameter must match.

index - - the expected position in the parameter list.

Returns:

This builder, for chaining.

parameterExactArray

public FuzzyMethodContract.Builder parameterExactArray(Class<?>... types)

Add a new required parameters by type and order for any matching method.

Parameters:

types - - the types of every parameters in order.

Returns:

This builder, for chaining.

parameterSuperOf

public FuzzyMethodContract.Builder parameterSuperOf(Class<?> type,
 int index)

Add a new required parameter whose type must be a superclass of the given type.

If a parameter is of type Number, any derived class (Integer, Long, etc.) will match it.

Parameters:

type - - a type or derived type of the matching parameter.

index - - the expected position in the parameter list.

Returns:

This builder, for chaining.

parameterDerivedOf

public FuzzyMethodContract.Builder parameterDerivedOf(Class<?> type,
 int index)

Add a new required parameter whose type must be a derived class of the given class.

If the method parameter has the type Integer, then the class Number here will match it.

Parameters:

type - - a type or more derived type of the matching parameter.

index - - the expected position in the parameter list.

Returns:

This builder, for chaining.

parameterMatches

public FuzzyMethodContract.Builder parameterMatches(AbstractFuzzyMatcher<Class<?>> classMatcher,
 int index)

Add a new required parameter whose type must match the given class matcher and index.

Parameters:

classMatcher - - the class matcher.

index - - the expected position in the parameter list.

Returns:

This builder, for chaining.

parameterCount

public FuzzyMethodContract.Builder parameterCount(int expectedCount)

Set the expected number of parameters in the matching method.

Parameters:

expectedCount - - the number of parameters to expect.

Returns:

This builder, for chaining.

returnTypeVoid

public FuzzyMethodContract.Builder returnTypeVoid()

Require a void method.

Returns:

This builder, for chaining.

returnTypeExact

public FuzzyMethodContract.Builder returnTypeExact(Class<?> type)

Set the return type of a matching method exactly.

Parameters:

type - - the exact return type.

Returns:

This builder, for chaining.

returnDerivedOf

public FuzzyMethodContract.Builder returnDerivedOf(Class<?> type)

Set the expected super class of the return type for every matching method.

Parameters:

type - - the return type, or a super class of it.

Returns:

This builder, for chaining.

returnTypeMatches

public FuzzyMethodContract.Builder returnTypeMatches(AbstractFuzzyMatcher<Class<?>> classMatcher)

Set a matcher that must match the return type of a matching method.

Parameters:

classMatcher - - the exact return type.

Returns:

This builder, for chaining.

exceptionExactType

public FuzzyMethodContract.Builder exceptionExactType(Class<?> type)

Add a throwable exception that must match the given type exactly.

Parameters:

type - - exception type.

Returns:

This builder, for chaining.

exceptionSuperOf

public FuzzyMethodContract.Builder exceptionSuperOf(Class<?> type)

Add a throwable exception that must match the given type or be derived.

Parameters:

type - - exception type.

Returns:

This builder, for chaining.

exceptionMatches

public FuzzyMethodContract.Builder exceptionMatches(AbstractFuzzyMatcher<Class<?>> classMatcher)

Add a throwable exception that must match the given matcher,

Parameters:

classMatcher - - the class matcher that must match.

Returns:

This builder, for chaining.

exceptionExactType

public FuzzyMethodContract.Builder exceptionExactType(Class<?> type,
 int index)

Add a throwable exception that must match the given type exactly and index.

Parameters:

type - - exception type.

index - - the position in the throwable list.

Returns:

This builder, for chaining.

exceptionSuperOf

public FuzzyMethodContract.Builder exceptionSuperOf(Class<?> type,
 int index)

Add a throwable exception that must match the given type or be derived and index.

Parameters:

type - - exception type.

index - - the position in the throwable list.

Returns:

This builder, for chaining.

exceptionMatches

public FuzzyMethodContract.Builder exceptionMatches(AbstractFuzzyMatcher<Class<?>> classMatcher,
 int index)

Add a throwable exception that must match the given matcher and index.

Parameters:

classMatcher - - the class matcher that must match.

index - - the position in the throwable list.

Returns:

This builder, for chaining.

initialMember

@Nonnull
protected FuzzyMethodContract initialMember()

Description copied from class: AbstractFuzzyMember.Builder

Construct a new instance of the current type.

Specified by:

initialMember in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Returns:

New instance.

build

public FuzzyMethodContract build()

Description copied from class: AbstractFuzzyMember.Builder

Build a new instance of this type.

Builders should call AbstractFuzzyMember.prepareBuild() when constructing new objects.

Specified by:

build in class AbstractFuzzyMember.Builder<FuzzyMethodContract>

Returns:

New instance of this type.