com.github.shynixn.petblocks.bukkit.logic.business.configuration

Class ParticleConfiguration

java.lang.Object

com.github.shynixn.petblocks.bukkit.logic.business.configuration.ParticleConfiguration

All Implemented Interfaces:

com.github.shynixn.petblocks.api.persistence.controller.CostumeController, com.github.shynixn.petblocks.api.persistence.controller.IController<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>, com.github.shynixn.petblocks.api.persistence.controller.IFileController<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>, com.github.shynixn.petblocks.api.persistence.controller.ParticleController, AutoCloseable

public class ParticleConfiguration
extends Object
implements com.github.shynixn.petblocks.api.persistence.controller.ParticleController

Copyright 2017 Shynixn

Do not remove this header!

Version 1.0

MIT License

Copyright (c) 2017

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Constructor Summary

Constructors

Constructor and Description
ParticleConfiguration(org.bukkit.plugin.Plugin plugin) Initializes a new engine repository

Method Summary

Modifier and Type	Method and Description
void	close() Closes this resource, relinquishing any underlying resources.
List<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>	getAll() Returns all items from the repository as unmodifiableList
com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta	getByItem(com.github.shynixn.petblocks.api.business.entity.GUIItemContainer container) Returns the particleEffect by the given container
com.github.shynixn.petblocks.api.business.entity.GUIItemContainer	getContainerByPosition(int id) Returns the container by the given order id
void	reload() Reloads the content from the fileSystem
void	remove(com.github.shynixn.petblocks.api.business.entity.GUIItemContainer item) Removes an item from the repository
int	size() Returns the amount of items in the repository
void	store(com.github.shynixn.petblocks.api.business.entity.GUIItemContainer item) Stores a new a item in the repository

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleConfiguration

public ParticleConfiguration(org.bukkit.plugin.Plugin plugin)

Initializes a new engine repository

Parameters:

plugin - plugin

Method Detail

store

public void store(com.github.shynixn.petblocks.api.business.entity.GUIItemContainer item)

Stores a new a item in the repository

Specified by:

store in interface com.github.shynixn.petblocks.api.persistence.controller.IController<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>

Parameters:

item - item

remove

public void remove(com.github.shynixn.petblocks.api.business.entity.GUIItemContainer item)

Removes an item from the repository

Specified by:

remove in interface com.github.shynixn.petblocks.api.persistence.controller.IController<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>

Parameters:

item - item

size

public int size()

Returns the amount of items in the repository

Specified by:

size in interface com.github.shynixn.petblocks.api.persistence.controller.IController<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>

Returns:

size

getAll

public List<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer> getAll()

Returns all items from the repository as unmodifiableList

Specified by:

getAll in interface com.github.shynixn.petblocks.api.persistence.controller.IController<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>

Returns:

items

getContainerByPosition

public com.github.shynixn.petblocks.api.business.entity.GUIItemContainer getContainerByPosition(int id)

Returns the container by the given order id

Specified by:

getContainerByPosition in interface com.github.shynixn.petblocks.api.persistence.controller.CostumeController

Parameters:

id - id

Returns:

container

getByItem

public com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta getByItem(com.github.shynixn.petblocks.api.business.entity.GUIItemContainer container)

Returns the particleEffect by the given container

Specified by:

getByItem in interface com.github.shynixn.petblocks.api.persistence.controller.ParticleController

Parameters:

container - container

Returns:

particleEffect

reload

public void reload()

Reloads the content from the fileSystem

Specified by:

reload in interface com.github.shynixn.petblocks.api.persistence.controller.IFileController<com.github.shynixn.petblocks.api.business.entity.GUIItemContainer>

close

public void close()
           throws Exception

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement. However, implementers of this interface are strongly encouraged to make their close methods idempotent.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if this resource cannot be closed