Files
PlayerVaults/src/main/java/com/drtshock/playervaults/converters/Converter.java
T
2015-06-27 09:37:10 -07:00

39 lines
1.1 KiB
Java

package com.drtshock.playervaults.converters;
import com.turt2live.uuid.ServiceProvider;
import org.bukkit.command.CommandSender;
/**
* Represents a simple converter for converting another plugin's content to PlayerVaults.
*
* @author turt2live
*/
public interface Converter {
/**
* Converts the other plugin's data.
*
* @param initiator the initiator of the conversion. May be null
* @param uuidProvider the UUID provider to use, cannot be null
*
* @return the number of vaults converted. Returns 0 on none converted or -1 if no vaults were converted.
*/
int run(CommandSender initiator, ServiceProvider uuidProvider);
/**
* Determines if this converter is applicable for converting to PlayerVaults. This may check for the existance of a
* plugin, plugin folder, or otherwise.
*
* @return true if this converter can convert, false otherwise
*/
boolean canConvert();
/**
* Gets the name of this converter
*
* @return the converter name
*/
String getName();
}