com.github.unafraid.plugins.installers.file

Class FileInstaller

java.lang.Object

com.github.unafraid.plugins.installers.file.FileInstaller

All Implemented Interfaces:

IPluginInstaller

public class FileInstaller
extends java.lang.Object
implements IPluginInstaller

A simple file installer that handles types of PluginFile holder class.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
FileInstaller()

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String source, java.lang.String destination) Registers a file into this installer.
void	addFolder(java.lang.String source, java.lang.String destination) Registers a folder into this installer.
boolean	equals(java.lang.Object obj)
java.util.Set<PluginFile>	getDirectories() Gets the registered directories inside this installer.
java.util.Set<PluginFile>	getFiles() Gets the registered files inside this installer.
int	hashCode()
void	install(AbstractPlugin plugin) Triggered whenever the plugin is being installed.
void	uninstall(AbstractPlugin plugin) Triggered whenever the plugin is being uninstalled.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

Constructor Detail

FileInstaller

public FileInstaller()

Method Detail

addFile

public void addFile(java.lang.String source,
                    java.lang.String destination)

Registers a file into this installer.

Parameters:

source - where installer should look for the original file

destination - where installer shall put the file

addFolder

public void addFolder(java.lang.String source,
                      java.lang.String destination)

Registers a folder into this installer.

Parameters:

source - where installer should look for the original folder

destination - where installer shall put the folder

getFiles

public java.util.Set<PluginFile> getFiles()

Gets the registered files inside this installer.

Returns:

files

getDirectories

public java.util.Set<PluginFile> getDirectories()

Gets the registered directories inside this installer.

Returns:

directories

install

public void install(AbstractPlugin plugin)
             throws PluginException

Description copied from interface: IPluginInstaller

Triggered whenever the plugin is being installed.

Specified by:

install in interface IPluginInstaller

Parameters:

plugin - the plugin

Throws:

PluginException

uninstall

public void uninstall(AbstractPlugin plugin)
               throws PluginException

Description copied from interface: IPluginInstaller

Triggered whenever the plugin is being uninstalled.

Specified by:

uninstall in interface IPluginInstaller

Parameters:

plugin - the plugin

Throws:

PluginException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object