com.thindeck.api

Interface Decks

All Known Implementing Classes:

FkDecks

@Immutable
public interface Decks

Decks of a User.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@teamed.io)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String name) Add a new deck.
void	delete(String name) Delete a deck.
Deck	get(String name) Get it by name.
Iterable<Deck>	iterate() Iterate them all.

Method Detail

get

@NotNull(message="deck can\'t be null")
Deck get(String name)
         throws IOException

Get it by name.

The method should throw a runtime exception if a deck with this name doesn't exist. You should call add(String) to create a deck first.

Parameters:

name - The name

Returns:

Deck

Throws:

IOException - If fails

add

void add(String name)
         throws IOException

Add a new deck.

The method should throw a runtime exception if a deck with this name already exists.

Parameters:

name - Unique name

Throws:

IOException - If fails

delete

void delete(String name)
            throws IOException

Delete a deck.

The method should throw a runtime exception if a deck with this name is absent.

Parameters:

name - Unique name

Throws:

IOException - If fails

iterate

@NotNull(message="iterable of decks can\'t be null")
Iterable<Deck> iterate()
                       throws IOException

Iterate them all.

Returns:

All decks of the user

Throws:

IOException - If fails