Skip to content

An android library developed with kotlin which comes in handy in developing shopping cart related applications.

Notifications You must be signed in to change notification settings

hishd/TinyCartKotlin

Repository files navigation

TinyCart for Kotlin

The kotlin version of the TinyCart android library which will come in handy for e-Commerce based android applications. The library can be used to maintain a cart for all the purchased items in a particular scenario.

Features

  • Adding new Items to the cart
  • Retrieving Items along with quantity
  • Update the Items in the cart
  • Get total price and quantity
  • Remove Items inside the cart
  • Custom handled exceptions

Installation

Add the repository to your project build.gradle

allprojects {
    repositories {
        google()
        jcenter()
        maven { url 'https://jitpack.io' }
    }
}

And add the library to your module build.gradle:

dependencies {
    implementation 'com.github.hishd:TinyCartKotlin:1.0.0'
}

Usage

After installing you must implement your Product class with using the interface Item ex:

class ElectronicItem(override val name: String, override val price: Double) : Item

After implementing the class the Cart can be initialized and used anywhere in your application ex:

val cart = Cart.getCart()

Usages of the methods.

Method Name Operation
addItem(item: Item, quantity: Int) Add a new item to the cart
updateQuantity(item: Item, quantity: Int) Add to an existing item quantity the the cart
removeItemQty(item: Item, quantity: Int) Removes quantity of a certain item
removeItem(item: Item) Removes an item in the cart
clearCart() Removes all the products and clear the cart
isCartEmpty() Checks and returns true if the cart is empty
int getItemQty(item: Item) Retrieves the quantity of a particular item
getTotalPrice() Retrieve the total price of the cart
getItemNames() Retrieves all the Items
getAllItemsWithQty() Retrieves all the items in the cart along with their quantity as Map
toString() Returns a concatenated string which contains the cart information

Exceptions

ProductNotFoundException() will throw while the requested product is not th the cart. QuantityInvalidException() will throw when the provided quantity is not valid

Please Refer the Sample project for more information.

About

An android library developed with kotlin which comes in handy in developing shopping cart related applications.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages