FacetBase (adventure-platform-facet 4.2.0 API)

java.lang.Object
- net.kyori.adventure.platform.facet.FacetBase<V>

Type Parameters:

V - the viewer type

All Implemented Interfaces:

Facet<V>
```
public abstract class FacetBase<V>
extends java.lang.Object
implements Facet<V>
```
A base implementation of a facet that validates viewer type.
This is not supported API. Subject to change at any time.

Since:

4.0.0

Nested Class Summary
- Nested classes/interfaces inherited from interface net.kyori.adventure.platform.facet.Facet
  Facet.ActionBar<V,M>, Facet.Book<V,M,B>, Facet.BossBar<V>, Facet.BossBarEntity<V,P>, Facet.BossBarPacket<V>, Facet.Chat<V,M>, Facet.ChatPacket<V,M>, Facet.EntitySound<V,M>, Facet.FakeEntity<V,P>, Facet.Message<V,M>, Facet.Pointers<V>, Facet.Position<V,P>, Facet.Sound<V,P>, Facet.TabList<V,M>, Facet.Title<V,M,C,T>, Facet.TitlePacket<V,M,C,T>

Field Summary

Fields
Modifier and Type Field Description

protected java.lang.Class<? extends V> viewerClass

Constructor Summary

Constructors
Modifier Constructor Description

protected FacetBase(@Nullable java.lang.Class<? extends V> viewerClass)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isApplicable(V viewer)`	Gets whether this handler is applicable to a particular viewer.
`boolean`	`isSupported()`	Gets whether this handler is supported by the current runtime.

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

- Field Detail
  - viewerClass
```
protected final java.lang.Class<? extends V> viewerClass
```
- Constructor Detail
  - FacetBase
```
protected FacetBase(@Nullable
                    @Nullable java.lang.Class<? extends V> viewerClass)
```
- Method Detail
  - isSupported
```
public boolean isSupported()
```
    Description copied from interface: Facet
    
    Gets whether this handler is supported by the current runtime.
    If not, this can be discarded since it will fail for all viewers.
    
    Specified by:
    
    isSupported in interface Facet<V>
    
    Returns:
    
    if this handler is supported
  - isApplicable
```
public boolean isApplicable(@NotNull
                            V viewer)
```
    Description copied from interface: Facet
    
    Gets whether this handler is applicable to a particular viewer.
    This should only be invoked if Facet.isSupported() is true.
    
    Specified by:
    
    isApplicable in interface Facet<V>
    
    Parameters:
    
    viewer - a viewer
    
    Returns:
    
    if this handler is applicable to a viewer