Package com.cryptomorin.xseries.base

Class XRegistry<XForm extends XBase<XForm,BukkitForm>,BukkitForm>

java.lang.Object

com.cryptomorin.xseries.base.XRegistry<XForm,BukkitForm>

Type Parameters:

XForm - The type used within this library.

BukkitForm - The corresponding Bukkit type of the XRegistry.

All Implemented Interfaces:

Iterable<XForm>

@Internal
public final class XRegistry<XForm extends XBase<XForm,BukkitForm>,BukkitForm>
extends Object
implements Iterable<XForm>

A registry similar to Bukkit's Registry. It holds values as a form of XBase and allows cross-version name mappings and also direct bukkit-to-xform mappings as well.

See Also:

• XBase
• XModule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	XRegistry.Ignore

Constructor Summary

Constructors

Constructor	Description
XRegistry(Class<BukkitForm> bukkitFormClass, Class<XForm> xFormClass, Function<Integer,XForm[]> createArray)
XRegistry(Class<BukkitForm> bukkitFormClass, Class<XForm> xFormClass, Supplier<Object> registrySupplier, BiFunction<BukkitForm,String[],XForm> creator, Function<Integer,XForm[]> createArray)

Method Summary

Modifier and Type	Method	Description
@NotNull Map<BukkitForm,XForm>	bukkitMapping()
void	discardMetadata()	Saves memory.
@NotNull Field	getBackingField(XForm xForm)
protected BukkitForm	getBukkit(String[] names)
Class<BukkitForm>	getBukkitFormClass()	Gets the class of the bukkit form.
static @NotNull String	getBukkitName(@NotNull Object bukkitForm)
XForm	getByBukkitForm(BukkitForm bukkit)
Optional<XForm>	getByName(@NotNull String name)
String	getName()	Gets the name of the registry, which is usually the bukkit form's simple class name.
XModuleMetadata	getOrRegisterMetadata(XForm form, Field formField, boolean peekOnly)
@Unmodifiable @NotNull Collection<XForm>	getValues()
Class<XForm>	getXFormClass()	Gets the class of the xform.
@NotNull Iterator<XForm>	iterator()
@NotNull Map<String,XForm>	nameMapping()
static @Nullable XRegistry<?,?>	rawRegistryOf(Class<?> clazz)	Gets the registry associated to a XBase class.
protected static <XForm extends XBase<XForm, BukkitForm>, BukkitForm> void	registerModule(XRegistry<XForm,BukkitForm> registry, Class<? extends XForm> clazz)
void	registerName(String name, XForm xForm)
static <XForm extends XBase<XForm, BukkitForm>, BukkitForm> @Nullable XRegistry<XForm,BukkitForm>	registryOf(Class<? extends XForm> clazz)	Gets the registry associated to a XBase class.
XForm	std(String[] names)
XForm	std(Function<BukkitForm,XForm> xForm, String[] names)
XForm	std(Function<BukkitForm,XForm> xForm, XForm tryOther, String[] names)
XForm	std(XForm xForm)
BukkitForm	stdEnum(XForm xForm, String[] names)
BukkitForm	stdEnum(XForm xForm, String[] names, BukkitForm bukkit)
String	toString()
XForm[]	values()	Deprecated. Use of values() should be discouraged by static XModule implementations, instead getValues() should be used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

XRegistry

@Internal
public XRegistry(Class<BukkitForm> bukkitFormClass,
 Class<XForm> xFormClass,
 Supplier<Object> registrySupplier,
 BiFunction<BukkitForm,String[],XForm> creator,
 Function<Integer,XForm[]> createArray)

XRegistry

@Internal
public XRegistry(Class<BukkitForm> bukkitFormClass,
 Class<XForm> xFormClass,
 Function<Integer,XForm[]> createArray)

Method Details

rawRegistryOf

@Nullable
@Experimental
public static @Nullable XRegistry<?,?> rawRegistryOf(Class<?> clazz)

Gets the registry associated to a XBase class. Usually this method is used for serialization purposes since the generic information of the class isn't always known.

See Also:

• registryOf(Class)

registryOf

@Nullable
@Experimental
public static <XForm extends XBase<XForm,
BukkitForm>,
BukkitForm>
@Nullable XRegistry<XForm,BukkitForm> registryOf(Class<? extends XForm> clazz)

Gets the registry associated to a XBase class.

See Also:

• rawRegistryOf(Class)

registerModule

protected static <XForm extends XBase<XForm,
BukkitForm>,
BukkitForm>
void registerModule(XRegistry<XForm,BukkitForm> registry,
 Class<? extends XForm> clazz)

nameMapping

@Internal
@NotNull
public @NotNull Map<String,XForm> nameMapping()

bukkitMapping

@Internal
@NotNull
public @NotNull Map<BukkitForm,XForm> bukkitMapping()

getBukkitFormClass

public Class<BukkitForm> getBukkitFormClass()

Gets the class of the bukkit form.

getXFormClass

public Class<XForm> getXFormClass()

Gets the class of the xform.

getName

public String getName()

Gets the name of the registry, which is usually the bukkit form's simple class name.

registerName

@Internal
public void registerName(String name,
 XForm xForm)

getBukkit

@Nullable
protected BukkitForm getBukkit(String[] names)

discardMetadata

@Internal
public void discardMetadata()

Saves memory.

getValues

@NotNull
public @Unmodifiable @NotNull Collection<XForm> getValues()

See Also:

• values()

values

@Deprecated
public XForm[] values()

Deprecated.

Use of values() should be discouraged by static XModule implementations, instead getValues() should be used.

iterator

@NotNull
public @NotNull Iterator<XForm> iterator()

Specified by:

iterator in interface Iterable<XForm extends XBase<XForm,BukkitForm>>

getByBukkitForm

@NotNull
public XForm getByBukkitForm(BukkitForm bukkit)

getByName

public Optional<XForm> getByName(@NotNull
 @NotNull String name)

getBukkitName

@Internal
@NotNull
public static @NotNull String getBukkitName(@NotNull
 @NotNull Object bukkitForm)

std

@Internal
public XForm std(String[] names)

stdEnum

@Internal
public BukkitForm stdEnum(XForm xForm,
 String[] names)

stdEnum

public BukkitForm stdEnum(XForm xForm,
 String[] names,
 BukkitForm bukkit)

getBackingField

@NotNull
@Internal
public @NotNull Field getBackingField(XForm xForm)

getOrRegisterMetadata

@Internal
public XModuleMetadata getOrRegisterMetadata(XForm form,
 Field formField,
 boolean peekOnly)

std

@Internal
public XForm std(Function<BukkitForm,XForm> xForm,
 String[] names)

std

@Internal
public XForm std(Function<BukkitForm,XForm> xForm,
 XForm tryOther,
 String[] names)

std

@Internal
public XForm std(XForm xForm)

toString

public String toString()

Overrides:

toString in class Object