src/org/mxchange/jshopcore/model/basket/Basket.java

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jshopcore.model.basket;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jshopcore.exceptions.BasketItemAlreadyAddedException;
  22
  23 /**
  24  * An interface for baskets
  25  * <p>
  26  * @author Roland Haeder<roland@mxchange.org>
  27  * @param <T> Any addable basket items
  28  */
  29 public interface Basket<T extends AddableBasketItem> extends Serializable {
  30
  31         /**
  32          * Adds given item instance to this basket
  33          * <p>
  34          * @param item Item instance to add
  35          * <p>
  36          * @throws org.mxchange.jshopcore.exceptions.BasketItemAlreadyAddedException
  37          *                                                                           If
  38          *                                                                           the
  39          *                                                                           item
  40          *                                                                           instance
  41          *                                                                           has
  42          *                                                                           already
  43          *                                                                           been
  44          *                                                                           added
  45          */
  46         void addItem (final T item) throws BasketItemAlreadyAddedException;
  47
  48         /**
  49          * Clears the basket instance
  50          */
  51         void clear ();
  52
  53         /**
  54          * Some "getter" for all entries in this basket
  55          * <p>
  56          * @return Map on all basket items
  57          */
  58         List<T> getAll ();
  59
  60         /**
  61          * Getter for last entry
  62          * <p>
  63          * @return Last added item in basket
  64          */
  65         T getLast ();
  66
  67         /**
  68          * Getter for basket size
  69          * <p>
  70          * @return Basket size
  71          */
  72         int size ();
  73
  74         /**
  75          * Checks whether the given item has already been added by checking the
  76          * item's id.
  77          * <p>
  78          * @param item Item instance to check
  79          * <p>
  80          * @return Whether the given item has been found
  81          */
  82         boolean isAdded (final T item);
  83
  84         /**
  85          * Checks if the basket is empty
  86          * <p>
  87          * @return Whether the basket is empty
  88          */
  89         boolean isEmpty ();
  90
  91         @Override
  92         boolean equals (final Object object);
  93
  94         @Override
  95         int hashCode ();
  96
  97 }