1 /**
2 * Copyright (c) 2014, stateful.co
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 stateful.co 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 co.stateful.quota;
31
32 import com.jcabi.aspects.Immutable;
33 import java.io.IOException;
34
35 /**
36 * Quota.
37 *
38 * @author Yegor Bugayenko (yegor@tpc2.com)
39 * @version $Id$
40 * @since 1.4
41 */
42 @Immutable
43 public interface Quota {
44
45 /**
46 * Unlimited.
47 */
48 Quota UNLIMITED = new Quota() {
49 @Override
50 public Quota into(final String path) {
51 return Quota.UNLIMITED;
52 }
53 @Override
54 public void use(final String name) {
55 // nothing to do
56 }
57 };
58
59 /**
60 * Into this path.
61 * @param path Path
62 * @return New quota
63 */
64 Quota into(String path);
65
66 /**
67 * Use this named service.
68 * @param name Name of the service
69 * @throws IOException If fails due to IO problem
70 */
71 void use(String name) throws IOException;
72
73 }