com.comphenix.protocol.reflect.fuzzy

Class AbstractFuzzyMember<T extends java.lang.reflect.Member>

java.lang.Object

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

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

Type Parameters:

T - - type that it matches.

All Implemented Interfaces:

java.lang.Comparable<AbstractFuzzyMatcher<T>>

Direct Known Subclasses:

FuzzyFieldContract, FuzzyMethodContract

public abstract class AbstractFuzzyMember<T extends java.lang.reflect.Member>
extends AbstractFuzzyMatcher<T>

Represents a matcher that matches members.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFuzzyMember.Builder<T extends AbstractFuzzyMember<?>> Represents a builder of a fuzzy member contract.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractFuzzyMatcher<java.lang.Class<?>>	declaringMatcher
protected int	modifiersBanned
protected int	modifiersRequired
protected java.util.regex.Pattern	nameRegex
protected boolean	sealed Whether or not this contract can be modified.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFuzzyMember()
protected	AbstractFuzzyMember(AbstractFuzzyMember<T> other)

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)
AbstractFuzzyMatcher<java.lang.Class<?>>	getDeclaringMatcher() Retrieve a class matcher for the declaring class of the member.
protected java.util.Map<java.lang.String,java.lang.Object>	getKeyValueView() Generate a view of this matcher as a key-value map.
int	getModifiersBanned() Retrieve a bit field of every Modifier that must not be present for the member to match.
int	getModifiersRequired() Retrieve a bit field of every Modifier that is required for the member to match.
java.util.regex.Pattern	getNameRegex() Retrieve the regular expression pattern that is used to match the name of a member.
int	hashCode()
boolean	isMatch(T value, java.lang.Object parent) Determine if the given value is a match.
protected void	prepareBuild() Called before a builder is building a member and copying its state.
java.lang.String	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

Field Detail

modifiersRequired

protected int modifiersRequired

modifiersBanned

protected int modifiersBanned

nameRegex

protected java.util.regex.Pattern nameRegex

declaringMatcher

protected AbstractFuzzyMatcher<java.lang.Class<?>> declaringMatcher

sealed

protected transient boolean sealed

Whether or not this contract can be modified.

Constructor Detail

AbstractFuzzyMember

protected AbstractFuzzyMember()

AbstractFuzzyMember

protected AbstractFuzzyMember(AbstractFuzzyMember<T> other)

Method Detail

prepareBuild

protected void prepareBuild()

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

Use this to prepare any special values.

getModifiersRequired

public int getModifiersRequired()

Retrieve a bit field of every Modifier that is required for the member to match.

Returns:

A required modifier bit field.

getModifiersBanned

public int getModifiersBanned()

Retrieve a bit field of every Modifier that must not be present for the member to match.

Returns:

A banned modifier bit field.

getNameRegex

public java.util.regex.Pattern getNameRegex()

Retrieve the regular expression pattern that is used to match the name of a member.

Returns:

The regex matching a name, or NULL if everything matches.

getDeclaringMatcher

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

Retrieve a class matcher for the declaring class of the member.

Returns:

An object matching the declaring class.

isMatch

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

Description copied from class: AbstractFuzzyMatcher

Determine if the given value is a match.

Specified by:

isMatch in class AbstractFuzzyMatcher<T extends java.lang.reflect.Member>

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.

Specified by:

calculateRoundNumber in class AbstractFuzzyMatcher<T extends java.lang.reflect.Member>

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getKeyValueView

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

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

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

Returns:

A modifiable key-value view.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object