Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Base |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright (c) 2014-2015, Thindeck.com | |
3 | * All rights reserved. | |
4 | * | |
5 | * Redistribution and use in source and binary forms, with or without | |
6 | * modification, are permitted provided that the following conditions | |
7 | * are met: 1) Redistributions of source code must retain the above | |
8 | * copyright notice, this list of conditions and the following | |
9 | * disclaimer. 2) Redistributions in binary form must reproduce the above | |
10 | * copyright notice, this list of conditions and the following | |
11 | * disclaimer in the documentation and/or other materials provided | |
12 | * with the distribution. 3) Neither the name of the thindeck.com nor | |
13 | * the names of its contributors may be used to endorse or promote | |
14 | * products derived from this software without specific prior written | |
15 | * permission. | |
16 | * | |
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
18 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT | |
19 | * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | |
20 | * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL | |
21 | * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | |
22 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
23 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
24 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
25 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
26 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
27 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | |
28 | * OF THE POSSIBILITY OF SUCH DAMAGE. | |
29 | */ | |
30 | package com.thindeck.api; | |
31 | ||
32 | import com.jcabi.aspects.Immutable; | |
33 | import java.io.IOException; | |
34 | import javax.validation.constraints.NotNull; | |
35 | ||
36 | /** | |
37 | * Base of the entire system. | |
38 | * | |
39 | * <p>Base is an entry point to the entire object model of | |
40 | * the system. You start from getting an instance of this type | |
41 | * from somewhere (depends on the implementation) and then | |
42 | * use one of the users or decks. | |
43 | * | |
44 | * @author Yegor Bugayenko (yegor@teamed.io) | |
45 | * @version $Id$ | |
46 | * @since 0.1 | |
47 | */ | |
48 | @Immutable | |
49 | public interface Base { | |
50 | ||
51 | /** | |
52 | * Get user by name. | |
53 | * | |
54 | * <p>If the user is absent, it should be automatically created | |
55 | * and returned. | |
56 | * | |
57 | * @param name His name | |
58 | * @return User found or created | |
59 | */ | |
60 | @NotNull(message = "user can't be null") | |
61 | User user(String name); | |
62 | ||
63 | /** | |
64 | * Get active decks, no matter what users they belong to. | |
65 | * | |
66 | * <p>This method is used only by a system-wide routine procedure | |
67 | * that goes through ALL decks. | |
68 | * | |
69 | * @return Decks | |
70 | * @throws IOException If fails | |
71 | */ | |
72 | @NotNull(message = "Decks can't be null") | |
73 | Iterable<Deck> active() throws IOException; | |
74 | ||
75 | } |