1 /*
2 * Copyright (c) 2012-2022, jcabi.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 jcabi.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.jcabi.manifests;
31
32 import java.io.IOException;
33 import java.util.Map;
34 import java.util.Set;
35
36 /**
37 * Map of manifest attributes.
38 *
39 * @see Manifests
40 * @since 1.1
41 */
42 public interface MfMap {
43
44 /**
45 * Get size of attributes map.
46 * @return Size of attributes map
47 * @since 2.0
48 */
49 int size();
50
51 /**
52 * Check if attributes map is empty.
53 * @return True if attributes map is empty and false otherwise
54 * @since 2.0
55 */
56 boolean isEmpty();
57
58 /**
59 * Check if attributes map contains the given key.
60 * @param key Attribute name
61 * @return True if attributes map contains the given key and false otherwise
62 * @since 2.0
63 */
64 boolean containsKey(String key);
65
66 /**
67 * Check if attributes map contains the given value.
68 * @param value Attribute value
69 * @return True if attributes map contains the given value and false otherwise
70 * @since 2.0
71 */
72 boolean containsValue(String value);
73
74 /**
75 * Get attribute value by its key.
76 * @param key Attribute name
77 * @return Value of the attribute and null if attribute not found
78 */
79 String get(String key);
80
81 /**
82 * Get a copy of attributes map.
83 * @return Copy of attributes map
84 * @since 2.0
85 */
86 Map<String, String> getAsMap();
87
88 /**
89 * Get a copy of a set of attributes keys.
90 * @return Copy of a set of attributes keys
91 * @since 2.0
92 */
93 Set<String> keySet();
94
95 /**
96 * Append this collection of MANIFEST.MF files.
97 *
98 * This method changes the original instance.
99 *
100 * @param mfs Content to append
101 * @throws IOException If fails on I/O problem
102 * @since 2.0.0
103 */
104 void append(Mfs mfs) throws IOException;
105 }