summaryrefslogtreecommitdiffstats
path: root/yang-compiler/src/main/java/org/onap/modeling/yangkit/catalog/ModuleInfo.java
blob: 5e128a3db75163c5d5cf33596e28feb4c32ef52b (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
Copyright 2023 Huawei Technologies

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.
*/

package org.onap.modeling.yangkit.catalog;

import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;

import java.net.URI;


public class ModuleInfo {
    private final String name;
    private final String revision;
    private String organization;
    private URI schema;

    /**
     * The constructor of ModuleInfo.
     *
     * @param name         module name
     * @param revision     module revision
     * @param organization the organization who publish this module
     */
    public ModuleInfo(String name, String revision, String organization) {
        this.name = name;
        this.revision = revision;
        this.organization = organization;
    }

    public ModuleInfo(String name, String revision) {
        this.name = name;
        this.revision = revision;
    }

    public void setSchema(URI schema) {
        this.schema = schema;
    }

    /**
     * get module name.
     *
     * @return module name
     */
    public String getName() {
        return name;
    }

    /**
     * get module's revision.
     *
     * @return revision
     */
    public String getRevision() {
        return revision;
    }

    /**
     * get organization.
     *
     * @return organization
     */
    public String getOrganization() {
        return organization;
    }

    /**
     * get schema.
     *
     * @return URI
     */
    public URI getSchema() {
        return schema;
    }

    /**
     * whether this module info with revision.
     * @return true or false
     */
    public boolean withRevision() {
        if (revision != null && !revision.isEmpty()) {
            return true;
        }
        return false;
    }

    /**
     * get the module information string.
     * @return module information
     */
    public String getModuleInfo() {
        if (withRevision()) {
            return name + "@" + revision;
        }
        return name;
    }

    /**
     * parse module info from json.
     *
     * @param element json element
     * @return ModuleInfo
     */
    public static ModuleInfo parse(JsonElement element) {
        JsonObject jsonObject = element.getAsJsonObject();
        String name = jsonObject.get("name").getAsString();
        String revision = jsonObject.get("revision").getAsString();
        JsonElement organizationElement = jsonObject.get("organization");
        String organization = null;
        if (organizationElement != null) {
            organization = organizationElement.getAsString();
        }
        JsonElement schemaElement = jsonObject.get("schema");
        if (schemaElement == null) {
            return null;
        }
        URI schema = URI.create(schemaElement.getAsString());
        if (name == null || revision == null || schema == null) {
            return null;
        }
        ModuleInfo moduleInfo = new ModuleInfo(name, revision, organization);
        moduleInfo.setSchema(schema);
        return moduleInfo;
    }

    /**
     * parse module information from json string.
     *
     * @param str json string
     * @return Module information
     */
    public static ModuleInfo parse(String str) {
        JsonElement element = JsonParser.parseString(str);
        JsonObject modules = element.getAsJsonObject();
        JsonElement moduleElement = modules.get("module");
        if (moduleElement == null) {
            return null;
        }
        JsonArray jsonArray = moduleElement.getAsJsonArray();
        if (jsonArray.size() != 1) {
            return null;
        }
        return parse(jsonArray.get(0));
    }
}