Package studio.magemonkey.codex.api.items.providers

Class VanillaProvider

java.lang.Object

studio.magemonkey.codex.api.items.providers.VanillaProvider

All Implemented Interfaces:

ICodexItemProvider<VanillaProvider.VanillaItemType>

public class VanillaProvider
extends Object
implements ICodexItemProvider<VanillaProvider.VanillaItemType>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VanillaProvider.VanillaItemType

Nested classes/interfaces inherited from interface studio.magemonkey.codex.api.items.providers.ICodexItemProvider

ICodexItemProvider.Category

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
VanillaProvider()

Method Summary

Modifier and Type	Method	Description
void	assertEnabled()
ICodexItemProvider.Category	getCategory()
VanillaProvider.VanillaItemType	getItem(String id)	Get an item from the provider.
VanillaProvider.VanillaItemType	getItem(org.bukkit.inventory.ItemStack itemStack)	Get the ItemType of this provider corresponding to the provided ItemStack.
String	getNamespace()
boolean	isCustomItem(org.bukkit.inventory.ItemStack item)	Check if the given item is from this provider.
boolean	isCustomItemOfId(org.bukkit.inventory.ItemStack item, String id)	Check if the given item is from this provider and has the given id.
String	pluginName()

Methods inherited from class java.lang.Object

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

Field Details

NAMESPACE

public static final String NAMESPACE

See Also:

• Constant Field Values

Constructor Details

VanillaProvider

public VanillaProvider()

Method Details

assertEnabled

public void assertEnabled()

Specified by:

assertEnabled in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

pluginName

public String pluginName()

Specified by:

pluginName in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

getCategory

public ICodexItemProvider.Category getCategory()

Specified by:

getCategory in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

getItem

@Nullable
public VanillaProvider.VanillaItemType getItem(String id)

Description copied from interface: ICodexItemProvider

Get an item from the provider.

Specified by:

getItem in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

Parameters:

id - The id of the item.

Returns:

The item with the given id.

getItem

@Nullable
public VanillaProvider.VanillaItemType getItem(org.bukkit.inventory.ItemStack itemStack)

Description copied from interface: ICodexItemProvider

Get the ItemType of this provider corresponding to the provided ItemStack.

Specified by:

getItem in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

Parameters:

itemStack - The item to get the ItemType from.

Returns:

the ItemType associated to the provided ItemStack, or null if not found.

isCustomItem

public boolean isCustomItem(org.bukkit.inventory.ItemStack item)

Description copied from interface: ICodexItemProvider

Check if the given item is from this provider.

Specified by:

isCustomItem in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

Parameters:

item - The item to check.

Returns:

Whether the item is from this provider.

isCustomItemOfId

public boolean isCustomItemOfId(org.bukkit.inventory.ItemStack item,
 String id)

Description copied from interface: ICodexItemProvider

Check if the given item is from this provider and has the given id.

Specified by:

isCustomItemOfId in interface ICodexItemProvider<VanillaProvider.VanillaItemType>

Parameters:

item - The item to check.

id - The id to check.

Returns:

Whether the item is from this provider and has the given id.