Slightly improve API, bump version to 3.2.0 for release

Methods are now properly annotated @Nullable when they may return null. More descriptive exceptions are thrown when issues occur instead of just returning null.
This commit is contained in:
Jikoo
2017-06-08 18:36:01 -04:00
parent 01f147b13c
commit 96c59f163d
35 changed files with 530 additions and 508 deletions

View File

@@ -1,57 +1,61 @@
/*
* Copyright (C) 2011-2014 lishid. All rights reserved.
*
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.lishid.openinv.internal;
import javax.annotation.Nullable;
import org.bukkit.inventory.Inventory;
public interface IInventoryAccess {
/**
* Check if an Inventory is an ISpecialPlayerInventory implementation.
*
* Gets an ISpecialEnderChest from an Inventory or null if the Inventory is not backed by an
* ISpecialEnderChest.
*
* @param inventory the Inventory
* @return true if the Inventory is backed by an ISpecialPlayerInventory
* @return the ISpecialEnderChest or null
*/
public boolean isSpecialPlayerInventory(Inventory inventory);
@Nullable
public ISpecialEnderChest getSpecialEnderChest(Inventory inventory);
/**
* Gets an ISpecialPlayerInventory from an Inventory or null if the Inventory is not backed by
* an ISpecialPlayerInventory.
*
*
* @param inventory the Inventory
* @return the ISpecialPlayerInventory or null
*/
@Nullable
public ISpecialPlayerInventory getSpecialPlayerInventory(Inventory inventory);
/**
* Check if an Inventory is an ISpecialEnderChest implementation.
*
*
* @param inventory the Inventory
* @return true if the Inventory is backed by an ISpecialEnderChest
*/
public boolean isSpecialEnderChest(Inventory inventory);
/**
* Gets an ISpecialEnderChest from an Inventory or null if the Inventory is not backed by an
* ISpecialEnderChest.
*
* Check if an Inventory is an ISpecialPlayerInventory implementation.
*
* @param inventory the Inventory
* @return the ISpecialEnderChest or null
* @return true if the Inventory is backed by an ISpecialPlayerInventory
*/
public ISpecialEnderChest getSpecialEnderChest(Inventory inventory);
public boolean isSpecialPlayerInventory(Inventory inventory);
}