com.github.shynixn.petblocks.api.persistence.controller.IController Maven / Gradle / Ivy

Go to download
package com.github.shynixn.petblocks.api.persistence.controller;

import java.util.List;

/**
 * Base Controller interface.
 * 
 * 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.
 */
public interface IController extends AutoCloseable {
    /**
     * Stores a new a item in the repository.
     *
     * @param item item
     */
    void store(T item);

    /**
     * Removes an item from the repository.
     *
     * @param item item
     */
    void remove(T item);

    /**
     * Returns the amount of items in the repository.
    *  @return size
     */
    int size();

    /**
     * Returns all items from the repository as unmodifiableList.
     *
     * @return items
    */
    List getAll();
}