minster586/OpenInv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 36 Wiki Activity

Cleaned up code, updated copyright at long last.

Browse Source
This commit is contained in:
Jikoo
2018-02-04 10:29:07 -05:00
parent eaf01fa32c
commit 50c45b6616
165 changed files with 1603 additions and 921 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
api/pom.xml
View File

@@ -1,3 +1,19 @@
<!--
~ Copyright (C) 2011-2018 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/>.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

56
api/src/main/java/com/lishid/openinv/IOpenInv.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright (C) 2011-2018 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;
import javax.annotation.Nullable;
@@ -26,7 +42,7 @@ public interface IOpenInv {
*
* @return false unless configured otherwise
*/
public boolean disableSaving();
boolean disableSaving();
/**
* Gets the active ISilentContainer implementation. May return null if the server version is
@@ -35,7 +51,7 @@ public interface IOpenInv {
* @return the ISilentContainer
* @throws IllegalStateException if the server version is unsupported
*/
public IAnySilentContainer getAnySilentContainer();
IAnySilentContainer getAnySilentContainer();
/**
* Gets an ISpecialEnderChest for the given Player. Returns null if the ISpecialEnderChest could
@@ -49,7 +65,7 @@ public interface IOpenInv {
*/
@Deprecated
@Nullable
public ISpecialEnderChest getEnderChest(Player player, boolean online);
ISpecialEnderChest getEnderChest(Player player, boolean online);
/**
* Gets an ISpecialPlayerInventory for the given Player. Returns null if the
@@ -63,7 +79,7 @@ public interface IOpenInv {
*/
@Deprecated
@Nullable
public ISpecialPlayerInventory getInventory(Player player, boolean online);
ISpecialPlayerInventory getInventory(Player player, boolean online);
/**
* Gets the active IInventoryAccess implementation. May return null if the server version is
@@ -72,7 +88,7 @@ public interface IOpenInv {
* @return the IInventoryAccess
* @throws IllegalStateException if the server version is unsupported
*/
public IInventoryAccess getInventoryAccess();
IInventoryAccess getInventoryAccess();
/**
* Gets the provided player's AnyChest setting.
@@ -81,7 +97,7 @@ public interface IOpenInv {
* @return true if AnyChest is enabled
* @throws IllegalStateException if the server version is unsupported
*/
public boolean getPlayerAnyChestStatus(OfflinePlayer player);
boolean getPlayerAnyChestStatus(OfflinePlayer player);
/**
* Gets a unique identifier by which the OfflinePlayer can be referenced. Using the value
@@ -91,7 +107,7 @@ public interface IOpenInv {
* @return the identifier
* @throws IllegalStateException if the server version is unsupported
*/
public String getPlayerID(OfflinePlayer offline);
String getPlayerID(OfflinePlayer offline);
/**
* Gets a player's SilentChest setting.
@@ -100,7 +116,7 @@ public interface IOpenInv {
* @return true if SilentChest is enabled
* @throws IllegalStateException if the server version is unsupported
*/
public boolean getPlayerSilentChestStatus(OfflinePlayer player);
boolean getPlayerSilentChestStatus(OfflinePlayer player);
/**
* Gets an ISpecialEnderChest for the given Player.
@@ -111,7 +127,7 @@ public interface IOpenInv {
* @throws IllegalStateException if the server version is unsupported
* @throws InstantiationException if the ISpecialEnderChest could not be instantiated
*/
public ISpecialEnderChest getSpecialEnderChest(Player player, boolean online) throws InstantiationException;
ISpecialEnderChest getSpecialEnderChest(Player player, boolean online) throws InstantiationException;
/**
* Gets an ISpecialPlayerInventory for the given Player.
@@ -122,14 +138,14 @@ public interface IOpenInv {
* @throws IllegalStateException if the server version is unsupported
* @throws InstantiationException if the ISpecialPlayerInventory could not be instantiated
*/
public ISpecialPlayerInventory getSpecialInventory(Player player, boolean online) throws InstantiationException;
ISpecialPlayerInventory getSpecialInventory(Player player, boolean online) throws InstantiationException;
/**
* Checks if the server version is supported by OpenInv.
*
* @return true if the server version is supported
*/
public boolean isSupportedVersion();
boolean isSupportedVersion();
/**
* Load a Player from an OfflinePlayer. May return null under some circumstances.
@@ -139,7 +155,7 @@ public interface IOpenInv {
* @throws IllegalStateException if the server version is unsupported
*/
@Nullable
public Player loadPlayer(final OfflinePlayer offline);
Player loadPlayer(final OfflinePlayer offline);
/**
* Get an OfflinePlayer by name.
@@ -152,7 +168,7 @@ public interface IOpenInv {
* @return the OfflinePlayer with the closest matching name or null if no players have ever logged in
*/
@Nullable
public OfflinePlayer matchPlayer(String name);
OfflinePlayer matchPlayer(String name);
/**
* Check the configuration value for whether or not OpenInv displays a notification to the user
@@ -160,7 +176,7 @@ public interface IOpenInv {
*
* @return true unless configured otherwise
*/
public boolean notifyAnyChest();
boolean notifyAnyChest();
/**
* Check the configuration value for whether or not OpenInv displays a notification to the user
@@ -168,7 +184,7 @@ public interface IOpenInv {
*
* @return true unless configured otherwise
*/
public boolean notifySilentChest();
boolean notifySilentChest();
/**
* Mark a Player as no longer in use by a Plugin to allow OpenInv to remove it from the cache
@@ -178,7 +194,7 @@ public interface IOpenInv {
* @param plugin the Plugin no longer holding a reference to the Player
* @throws IllegalStateException if the server version is unsupported
*/
public void releasePlayer(Player player, Plugin plugin);
void releasePlayer(Player player, Plugin plugin);
/**
* Mark a Player as in use by a Plugin to prevent it from being removed from the cache. Used to
@@ -203,7 +219,7 @@ public interface IOpenInv {
* @param plugin the Plugin holding the reference to the Player
* @throws IllegalStateException if the server version is unsupported
*/
public void retainPlayer(Player player, Plugin plugin);
void retainPlayer(Player player, Plugin plugin);
/**
* Sets a player's AnyChest setting.
@@ -212,7 +228,7 @@ public interface IOpenInv {
* @param status the status
* @throws IllegalStateException if the server version is unsupported
*/
public void setPlayerAnyChestStatus(OfflinePlayer player, boolean status);
void setPlayerAnyChestStatus(OfflinePlayer player, boolean status);
/**
* Sets a player's SilentChest setting.
@@ -221,7 +237,7 @@ public interface IOpenInv {
* @param status the status
* @throws IllegalStateException if the server version is unsupported
*/
public void setPlayerSilentChestStatus(OfflinePlayer player, boolean status);
void setPlayerSilentChestStatus(OfflinePlayer player, boolean status);
/**
* Forcibly unload a cached Player's data.
@@ -229,6 +245,6 @@ public interface IOpenInv {
* @param player the OfflinePlayer to unload
* @throws IllegalStateException if the server version is unsupported
*/
public void unload(OfflinePlayer player);
void unload(OfflinePlayer player);
}

24
api/src/main/java/com/lishid/openinv/internal/IAnySilentContainer.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright (C) 2011-2018 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 org.bukkit.block.Block;
@@ -15,14 +31,14 @@ public interface IAnySilentContainer {
* @param block the Block
* @return true if the container can be opened
*/
public boolean activateContainer(Player player, boolean silentchest, Block block);
boolean activateContainer(Player player, boolean silentchest, Block block);
/**
* Closes the Player's currently open container silently, if necessary.
*
* @param player the Player closing a container
*/
public void deactivateContainer(Player player);
void deactivateContainer(Player player);
/**
* Checks if the container at the given coordinates is blocked.
@@ -31,7 +47,7 @@ public interface IAnySilentContainer {
* @param block the Block
* @return true if the container is blocked
*/
public boolean isAnyContainerNeeded(Player player, Block block);
boolean isAnyContainerNeeded(Player player, Block block);
/**
* Checks if the given block is a container which can be unblocked or silenced.
@@ -39,6 +55,6 @@ public interface IAnySilentContainer {
* @param block the BlockState
* @return true if the Block is a supported container
*/
public boolean isAnySilentContainer(Block block);
boolean isAnySilentContainer(Block block);
}

14
api/src/main/java/com/lishid/openinv/internal/IInventoryAccess.java
View File

@@ -1,13 +1,13 @@
/*
* Copyright (C) 2011-2014 lishid. All rights reserved.
* Copyright (C) 2011-2018 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.
* 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
* 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
@@ -30,7 +30,7 @@ public interface IInventoryAccess {
* @return the ISpecialEnderChest or null
*/
@Nullable
public ISpecialEnderChest getSpecialEnderChest(Inventory inventory);
ISpecialEnderChest getSpecialEnderChest(Inventory inventory);
/**
* Gets an ISpecialPlayerInventory from an Inventory or null if the Inventory is not backed by
@@ -40,7 +40,7 @@ public interface IInventoryAccess {
* @return the ISpecialPlayerInventory or null
*/
@Nullable
public ISpecialPlayerInventory getSpecialPlayerInventory(Inventory inventory);
ISpecialPlayerInventory getSpecialPlayerInventory(Inventory inventory);
/**
* Check if an Inventory is an ISpecialEnderChest implementation.
@@ -48,7 +48,7 @@ public interface IInventoryAccess {
* @param inventory the Inventory
* @return true if the Inventory is backed by an ISpecialEnderChest
*/
public boolean isSpecialEnderChest(Inventory inventory);
boolean isSpecialEnderChest(Inventory inventory);
/**
* Check if an Inventory is an ISpecialPlayerInventory implementation.
@@ -56,6 +56,6 @@ public interface IInventoryAccess {
* @param inventory the Inventory
* @return true if the Inventory is backed by an ISpecialPlayerInventory
*/
public boolean isSpecialPlayerInventory(Inventory inventory);
boolean isSpecialPlayerInventory(Inventory inventory);
}

26
api/src/main/java/com/lishid/openinv/internal/ISpecialEnderChest.java
View File

@@ -1,15 +1,15 @@
/*
* Copyright (C) 2011-2014 lishid. All rights reserved.
*
* Copyright (C) 2011-2018 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.
*
* 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
* 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/>.
*/
@@ -23,28 +23,28 @@ public interface ISpecialEnderChest {
/**
* Gets the Inventory associated with this ISpecialEnderChest.
*
*
* @return the Inventory
*/
public Inventory getBukkitInventory();
Inventory getBukkitInventory();
/**
* Sets the Player associated with this ISpecialEnderChest online.
*
*
* @param player the Player coming online
*/
public void setPlayerOnline(Player player);
void setPlayerOnline(Player player);
/**
* Sets the Player associated with this ISpecialEnderChest offline.
*/
public void setPlayerOffline();
void setPlayerOffline();
/**
* Gets whether or not this ISpecialEnderChest is in use.
*
*
* @return true if the ISpecialEnderChest is in use
*/
public boolean isInUse();
boolean isInUse();
}

26
api/src/main/java/com/lishid/openinv/internal/ISpecialPlayerInventory.java
View File

@@ -1,15 +1,15 @@
/*
* Copyright (C) 2011-2014 lishid. All rights reserved.
*
* Copyright (C) 2011-2018 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.
*
* 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
* 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/>.
*/
@@ -23,28 +23,28 @@ public interface ISpecialPlayerInventory {
/**
* Gets the Inventory associated with this ISpecialPlayerInventory.
*
*
* @return the Inventory
*/
public Inventory getBukkitInventory();
Inventory getBukkitInventory();
/**
* Sets the Player associated with this ISpecialPlayerInventory online.
*
*
* @param player the Player coming online
*/
public void setPlayerOnline(Player player);
void setPlayerOnline(Player player);
/**
* Sets the Player associated with this ISpecialPlayerInventory offline.
*/
public void setPlayerOffline();
void setPlayerOffline();
/**
* Gets whether or not this ISpecialPlayerInventory is in use.
*
*
* @return true if the ISpecialPlayerInventory is in use
*/
public boolean isInUse();
boolean isInUse();
}