com.github.shynixn.petblocks.api.business.controller

Interface PetBlockController

All Superinterfaces:

AutoCloseable, IController<PetBlock>

public interface PetBlockController
extends IController<PetBlock>

Registers petblocks to manage their action and behavior.

Version 1.1

MIT License

Copyright (c) 2017 by Shynixn

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.

Method Summary

Modifier and Type	Method and Description
PetBlock	create(Object player, PetMeta petMeta) Creates a new petblock for the given player and meta.
PetBlock	getByPlayer(Object player) Deprecated.
Optional<PetBlock>	getFromPlayer(Object player) Returns the petblock of the given player.
void	removeByPlayer(Object player) Removes the petblock of the given player.

Methods inherited from interface com.github.shynixn.petblocks.api.persistence.controller.IController

getAll, remove, size, store

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

PetBlock create(Object player,
                PetMeta petMeta)

Creates a new petblock for the given player and meta.

Parameters:

player - player

petMeta - meta

Returns:

petblock

getByPlayer

@Deprecated
PetBlock getByPlayer(Object player)

Deprecated.

Returns the petblock of the given player.

Parameters:

player - player

Returns:

petblock

getFromPlayer

Optional<PetBlock> getFromPlayer(Object player)

Returns the petblock of the given player.

Parameters:

player - player

Returns:

petblock

removeByPlayer

void removeByPlayer(Object player)

Removes the petblock of the given player.

Parameters:

player - player