FuzzyFieldContract.Builder (ProtocolLib JavaDocs)

java.lang.Object
- com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember.Builder<FuzzyFieldContract>
- - com.comphenix.protocol.reflect.fuzzy.FuzzyFieldContract.Builder

Enclosing class:: FuzzyFieldContract

public static class FuzzyFieldContract.Builder
extends AbstractFuzzyMember.Builder<FuzzyFieldContract>

Represents a builder for a field matcher.

Author:: Kristian

Field Summary
- Fields inherited from class com.comphenix.protocol.reflect.fuzzy.AbstractFuzzyMember.Builder
  member

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FuzzyFieldContract.Builder`	`banModifier(int modifier)` Add a given bit-field of modifers that will skip or ignore members.
`FuzzyFieldContract`	`build()` Build a new instance of this type.
`FuzzyFieldContract.Builder`	`declaringClassDerivedOf(Class<?> declaringClass)` Require that a member is defined by this exact class, or any super class.
`FuzzyFieldContract.Builder`	`declaringClassExactType(Class<?> declaringClass)` Require that a member is defined by this exact class.
`FuzzyFieldContract.Builder`	`declaringClassMatching(AbstractFuzzyMatcher<Class<?>> classMatcher)` Require that a member is defined by a class that matches the given matcher.
`FuzzyFieldContract.Builder`	`declaringClassSuperOf(Class<?> declaringClass)` Require that a member is defined by this exact class, or any super class.
`protected FuzzyFieldContract`	`initialMember()` Construct a new instance of the current type.
`FuzzyFieldContract.Builder`	`nameExact(String name)` Set the exact name of the member we are matching.
`FuzzyFieldContract.Builder`	`nameRegex(Pattern pattern)` Set the regular expression pattern that matches a members name.
`FuzzyFieldContract.Builder`	`nameRegex(String regex)` Set the regular expresson that matches a members name.
`FuzzyFieldContract.Builder`	`requireModifier(int modifier)` Add a given bit-field of required modifiers for every matching member.
`FuzzyFieldContract.Builder`	`requirePublic()` Require that every matching member is public.
`FuzzyFieldContract.Builder`	`typeDerivedOf(Class<?> type)`
`FuzzyFieldContract.Builder`	`typeExact(Class<?> type)`
`FuzzyFieldContract.Builder`	`typeMatches(AbstractFuzzyMatcher<Class<?>> matcher)`
`FuzzyFieldContract.Builder`	`typeSuperOf(Class<?> type)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - requireModifier
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    modifier - - bit-field of modifiers that are required.
    
    Returns:
    
    This builder, for chaining.
  - banModifier
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    modifier - - bit-field of modifiers to skip or ignore.
    
    Returns:
    
    This builder, for chaining.
  - requirePublic
```
public FuzzyFieldContract.Builder requirePublic()
```
    Description copied from class: AbstractFuzzyMember.Builder
    
    Require that every matching member is public.
    
    Overrides:
    
    requirePublic in class AbstractFuzzyMember.Builder<FuzzyFieldContract>
    
    Returns:
    
    This builder, for chaining.
  - nameRegex
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    regex - - new regular expression of valid names.
    
    Returns:
    
    This builder, for chaining.
  - nameRegex
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    pattern - - regular expression pattern for a valid name.
    
    Returns:
    
    This builder, for chaining.
  - nameExact
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    name - - exact name.
    
    Returns:
    
    This builder, for chaining.
  - declaringClassExactType
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    declaringClass - - the declaring class of any matching member.
    
    Returns:
    
    This builder, for chaining.
  - declaringClassSuperOf
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    declaringClass - - the declaring class.
    
    Returns:
    
    This builder, for chaining.
  - declaringClassDerivedOf
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    declaringClass - - the declaring class.
    
    Returns:
    
    This builder, for chaining.
  - declaringClassMatching
```
public FuzzyFieldContract.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<FuzzyFieldContract>
    
    Parameters:
    
    classMatcher - - class matcher.
    
    Returns:
    
    This builder, for chaining.
  - initialMember
```
@Nonnull
protected FuzzyFieldContract initialMember()
```
    Description copied from class: AbstractFuzzyMember.Builder
    
    Construct a new instance of the current type.
    
    Specified by:
    
    initialMember in class AbstractFuzzyMember.Builder<FuzzyFieldContract>
    
    Returns:
    
    New instance.
  - typeExact
```
public FuzzyFieldContract.Builder typeExact(Class<?> type)
```
  - typeSuperOf
```
public FuzzyFieldContract.Builder typeSuperOf(Class<?> type)
```
  - typeDerivedOf
```
public FuzzyFieldContract.Builder typeDerivedOf(Class<?> type)
```
  - typeMatches
```
public FuzzyFieldContract.Builder typeMatches(AbstractFuzzyMatcher<Class<?>> matcher)
```
  - build
```
public FuzzyFieldContract 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<FuzzyFieldContract>
    
    Returns:
    
    New instance of this type.

Class FuzzyFieldContract.Builder

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

requireModifier

banModifier

requirePublic

nameRegex

nameRegex

nameExact

declaringClassExactType

declaringClassSuperOf

declaringClassDerivedOf

declaringClassMatching

initialMember

typeExact

typeSuperOf

typeDerivedOf

typeMatches

build