com.comphenix.protocol.reflect.fuzzy

Class FuzzyMethodContract

java.lang.Object

com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher<T>

com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember<MethodInfo>

com.comphenix.protocol.reflect.fuzzy.FuzzyMethodContract

All Implemented Interfaces:

java.lang.Comparable<AbstractFuzzyMatcher<MethodInfo>>

public class FuzzyMethodContract
extends AbstractFuzzyMember<MethodInfo>

Represents a contract for matching methods or constructors.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FuzzyMethodContract.Builder Represents a builder for a fuzzy method contract.

Field Summary

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

declaringMatcher, modifiersBanned, modifiersRequired, nameRegex, sealed

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateRoundNumber() Calculate the round number indicating when this matcher should be applied.
boolean	equals(java.lang.Object obj)
java.util.List<com.comphenix.protocol.reflect.fuzzy.FuzzyMethodContract.ParameterClassMatcher>	getExceptionMatchers() Retrieve an immutable list of every exception matcher for this method.
protected java.util.Map<java.lang.String,java.lang.Object>	getKeyValueView() Generate a view of this matcher as a key-value map.
java.lang.Integer	getParamCount() Retrieve the expected parameter count for this method.
com.google.common.collect.ImmutableList<com.comphenix.protocol.reflect.fuzzy.FuzzyMethodContract.ParameterClassMatcher>	getParamMatchers() Retrieve an immutable list of every parameter matcher for this method.
AbstractFuzzyMatcher<java.lang.Class<?>>	getReturnMatcher() Retrieve the class matcher for the return type.
int	hashCode()
boolean	isMatch(MethodInfo value, java.lang.Object parent) Determine if the given value is a match.
static FuzzyMethodContract.Builder	newBuilder() Return a method contract builder.
protected void	prepareBuild() Called before a builder is building a member and copying its state.

Methods inherited from class com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember

getDeclaringMatcher, getModifiersBanned, getModifiersRequired, getNameRegex, toString

Methods inherited from class com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher

and, combineRounds, compareTo, getRoundNumber, inverted, or

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static FuzzyMethodContract.Builder newBuilder()

Return a method contract builder.

Returns:

Method contract builder.

getReturnMatcher

public AbstractFuzzyMatcher<java.lang.Class<?>> getReturnMatcher()

Retrieve the class matcher for the return type.

Returns:

Class matcher for the return type.

getParamMatchers

public com.google.common.collect.ImmutableList<com.comphenix.protocol.reflect.fuzzy.FuzzyMethodContract.ParameterClassMatcher> getParamMatchers()

Retrieve an immutable list of every parameter matcher for this method.

Returns:

Immutable list of every parameter matcher.

getExceptionMatchers

public java.util.List<com.comphenix.protocol.reflect.fuzzy.FuzzyMethodContract.ParameterClassMatcher> getExceptionMatchers()

Retrieve an immutable list of every exception matcher for this method.

Returns:

Immutable list of every exception matcher.

getParamCount

public java.lang.Integer getParamCount()

Retrieve the expected parameter count for this method.

Returns:

Expected parameter count, or NULL if anyting goes.

prepareBuild

protected void prepareBuild()

Description copied from class: AbstractFuzzyMember

Called before a builder is building a member and copying its state.

Use this to prepare any special values.

Overrides:

prepareBuild in class AbstractFuzzyMember<MethodInfo>

isMatch

public boolean isMatch(MethodInfo value,
              java.lang.Object parent)

Description copied from class: AbstractFuzzyMatcher

Determine if the given value is a match.

Overrides:

isMatch in class AbstractFuzzyMember<MethodInfo>

Parameters:

value - - the value to match.

parent - - the parent container, or NULL if this value is the root.

Returns:

TRUE if it is a match, FALSE otherwise.

calculateRoundNumber

protected int calculateRoundNumber()

Description copied from class: AbstractFuzzyMatcher

Calculate the round number indicating when this matcher should be applied.

Matchers with a lower round number are applied before matchers with a higher round number.

By convention, this round number should be negative, except for zero in the case of a matcher that accepts any value. A good implementation should return the inverted tree depth (class hierachy) of the least specified type used in the matching. Thus Integer will have a lower round number than Number.

Overrides:

calculateRoundNumber in class AbstractFuzzyMember<MethodInfo>

Returns:

A number (positive or negative) that is used to order matchers.

getKeyValueView

protected java.util.Map<java.lang.String,java.lang.Object> getKeyValueView()

Description copied from class: AbstractFuzzyMember

Generate a view of this matcher as a key-value map.

Used by AbstractFuzzyMember.toString() to print a representation of this object.

Overrides:

getKeyValueView in class AbstractFuzzyMember<MethodInfo>

Returns:

A modifiable key-value view.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractFuzzyMember<MethodInfo>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractFuzzyMember<MethodInfo>