com.comphenix.protocol.reflect.fuzzy

Class FuzzyClassContract

java.lang.Object

com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMatcher<java.lang.Class<?>>

com.comphenix.protocol.reflect.fuzzy.FuzzyClassContract

All Implemented Interfaces:

java.lang.Comparable<AbstractFuzzyMatcher<java.lang.Class<?>>>

public class FuzzyClassContract
extends AbstractFuzzyMatcher<java.lang.Class<?>>

Determine if a given class implements a given fuzzy (duck typed) contract.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FuzzyClassContract.Builder Represents a class contract builder.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateRoundNumber() Calculate the round number indicating when this matcher should be applied.
com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<java.lang.Class<?>>>	getBaseclassContracts() Retrieve an immutable list of every baseclass contract.
com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<MethodInfo>>	getConstructorContracts() Retrieve an immutable list of every constructor contract.
com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<java.lang.reflect.Field>>	getFieldContracts() Retrieve an immutable list of every field contract.
com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<java.lang.Class<?>>>	getInterfaceContracts() Retrieve an immutable list of every interface contract.
com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<MethodInfo>>	getMethodContracts() Retrieve an immutable list of every method contract.
boolean	isMatch(java.lang.Class<?> value, java.lang.Object parent) Determine if the given value is a match.
static FuzzyClassContract.Builder	newBuilder() Construct a new fuzzy class contract builder.
java.lang.String	toString()

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

and, combineRounds, combineRounds, compareTo, getRoundNumber, inverted, or

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static FuzzyClassContract.Builder newBuilder()

Construct a new fuzzy class contract builder.

Returns:

A new builder.

getFieldContracts

public com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<java.lang.reflect.Field>> getFieldContracts()

Retrieve an immutable list of every field contract.

This list is ordered in descending order of priority.

Returns:

List of every field contract.

getMethodContracts

public com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<MethodInfo>> getMethodContracts()

Retrieve an immutable list of every method contract.

This list is ordered in descending order of priority.

Returns:

List of every method contract.

getConstructorContracts

public com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<MethodInfo>> getConstructorContracts()

Retrieve an immutable list of every constructor contract.

This list is ordered in descending order of priority.

Returns:

List of every constructor contract.

getBaseclassContracts

public com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<java.lang.Class<?>>> getBaseclassContracts()

Retrieve an immutable list of every baseclass contract.

This list is ordered in descending order of priority.

Returns:

List of every baseclass contract.

getInterfaceContracts

public com.google.common.collect.ImmutableList<AbstractFuzzyMatcher<java.lang.Class<?>>> getInterfaceContracts()

Retrieve an immutable list of every interface contract.

This list is ordered in descending order of priority.

Returns:

List of every interface contract.

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<java.lang.Class<?>>

Returns:

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

isMatch

public boolean isMatch(java.lang.Class<?> value,
              java.lang.Object parent)

Description copied from class: AbstractFuzzyMatcher

Determine if the given value is a match.

Specified by:

isMatch in class AbstractFuzzyMatcher<java.lang.Class<?>>

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object