Improve javadoc comments and formatting
[aai/babel.git] / src / main / java / org / onap / aai / babel / xml / generator / ArtifactGenerator.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
6  * Copyright (c) 2017-2019 European Software Marketing Ltd.
7  * ================================================================================
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  *       http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  * ============LICENSE_END=========================================================
20  */
21
22 package org.onap.aai.babel.xml.generator;
23
24 import java.util.List;
25 import org.onap.aai.babel.service.data.BabelArtifact;
26 import org.onap.aai.babel.xml.generator.data.Artifact;
27
28 @FunctionalInterface
29 public interface ArtifactGenerator {
30
31     /**
32      * Generate a {@link List} of {@link BabelArtifact}s from the Artifacts obtained from the CSAR
33      *
34      * @param csarArchive
35      *            original CSAR file (zip format)
36      * @param csarArtifacts
37      *            YAML artifacts extracted from the CSAR file
38      * @return generated {@link BabelArtifact}s
39      * @throws XmlArtifactGenerationException
40      */
41     List<BabelArtifact> generateArtifacts(byte[] csarArchive, List<Artifact> csarArtifacts)
42             throws XmlArtifactGenerationException;
43 }