summaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-tosca-lib/src/main/java/org/openecomp/sdc/tosca/csar/ToscaMetadata.java
blob: 483afb7710954f69b3ac40219aa865053448c5ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2019, Nordix Foundation. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */
package org.openecomp.sdc.tosca.csar;

import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.openecomp.sdc.datatypes.error.ErrorMessage;

public interface ToscaMetadata {

    /**
     * Checks if metadata file is valid.
     *
     * @return {@code true} if the metadata is valid, {@code false} otherwise
     */
    boolean isValid();

    /**
     * Gets the list of errors occurred during manifest parsing.
     *
     * @return the list of errors
     */
    List<ErrorMessage> getErrors();

    /**
     * Metadata entries of block_0.
     *
     * @return a map representing the entries
     */
    Map<String, String> getMetaEntries();

    /**
     * Checks if the entry exists.
     *
     * @param entry the entry name.
     * @return {@code true} if the entry exists, {@code false} otherwise.
     */
    boolean hasEntry(String entry);

    /**
     * Get the entry value if it exists.
     *
     * @param entry the entry to retrieve the value.
     * @return an optional with the entry value if it exists.
     */
    Optional<String> getEntry(ToscaMetaEntry entry);
}