Record Class ExtensionFilter

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.configuration.ExtensionFilter

Record Components:

filterStrategy - the ExtensionFilter.FilterStrategy to use

classes - the names of base packages of the Classes to filter according to the used ExtensionFilter.FilterStrategy

All Implemented Interfaces:

Predicate<ServiceLoader.Provider<Extension>>

public record ExtensionFilter(ExtensionFilter.FilterStrategy filterStrategy, Collection<String> classes)
extends Record
implements Predicate<ServiceLoader.Provider<Extension>>

A Predicate to test whether an Extension should be loaded or not.

See Also:

• JDACBuilder.filterExtensions(FilterStrategy, String...)
• test(Provider)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExtensionFilter.FilterStrategy	The two available filter strategies

Constructor Summary

Constructors

Constructor	Description
ExtensionFilter(ExtensionFilter.FilterStrategy filterStrategy, Collection<String> classes)	Creates an instance of a ExtensionFilter record class.

Method Summary

Modifier and Type	Method	Description
Collection<String>	classes()	Returns the value of the classes record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ExtensionFilter.FilterStrategy	filterStrategy()	Returns the value of the filterStrategy record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	test(ServiceLoader.Provider<Extension> provider)	Tests whether an Extension should be used or not according to this filter.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface Predicate

and, negate, or

Constructor Details

ExtensionFilter

public ExtensionFilter(ExtensionFilter.FilterStrategy filterStrategy,
 Collection<String> classes)

Creates an instance of a ExtensionFilter record class.

Parameters:

filterStrategy - the value for the filterStrategy record component

classes - the value for the classes record component

Method Details

test

public boolean test(ServiceLoader.Provider<Extension> provider)

Tests whether an Extension should be used or not according to this filter. The

Specified by:

test in interface Predicate<ServiceLoader.Provider<Extension>>

Parameters:

provider - the 'unloaded' Extension to test (still wrapped by ServiceLoader.Provider)

Returns:

whether to use the extension

Implementation Note:

This method compares the fully classified class name of the Extension implementation to classes() by using String.startsWith(String), so it's possible to include/exclude an extensions by only using a part of the full name/packages.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

filterStrategy

public ExtensionFilter.FilterStrategy filterStrategy()

Returns the value of the filterStrategy record component.

Returns:

the value of the filterStrategy record component

classes

public Collection<String> classes()

Returns the value of the classes record component.

Returns:

the value of the classes record component