summaryrefslogtreecommitdiffstats
path: root/vpp-integration/api-docs/api/src/main/java/io/fd/hc2vpp/docs/api/CoverageUnit.java
blob: e04d28304cd6f8e7b467519ebae0559576904b54 (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
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 *
 * 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 io.fd.hc2vpp.docs.api;

import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.Set;

/**
 * Represents mapping between single supported VPP binary api and its binding
 */
public class CoverageUnit {

    /**
     * VPP binary api reference
     */
    private final VppApiMessage vppApi;

    /**
     * Java equivalent of VPP binary api
     */
    private final JavaApiMessage javaApi;

    /**
     * Yang types used to bind this request
     */
    private final List<YangType> yangTypes;

    /**
     * Operations supported for this api
     */
    private final Collection<Operation> supportedOperations;

    private CoverageUnit(final VppApiMessage vppApi, final JavaApiMessage javaApi,
                         final List<YangType> yangTypes,
                         final Collection<Operation> supportedOperations) {
        this.vppApi = vppApi;
        this.javaApi = javaApi;
        this.yangTypes = yangTypes;
        this.supportedOperations = supportedOperations;
    }

    public VppApiMessage getVppApi() {
        return vppApi;
    }

    public JavaApiMessage getJavaApi() {
        return javaApi;
    }

    public List<YangType> getYangTypes() {
        return yangTypes;
    }

    public Collection<Operation> getSupportedOperations() {
        return supportedOperations;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        final CoverageUnit that = (CoverageUnit) o;

        return Objects.equals(this.vppApi, that.vppApi) &&
                Objects.equals(this.javaApi, that.javaApi) &&
                Objects.equals(this.yangTypes, that.yangTypes) &&
                Objects.equals(this.supportedOperations, that.supportedOperations);
    }

    @Override
    public int hashCode() {
        return Objects.hash(vppApi, javaApi, yangTypes, supportedOperations);
    }

    public static class CoverageUnitBuilder {
        private VppApiMessage vppApi;
        private JavaApiMessage javaApi;
        private List<YangType> yangTypes;
        private Set<Operation> supportedOperations;

        public CoverageUnitBuilder setVppApi(final VppApiMessage vppApi) {
            this.vppApi = vppApi;
            return this;
        }

        public CoverageUnitBuilder setJavaApi(final JavaApiMessage javaApi) {
            this.javaApi = javaApi;
            return this;
        }

        public CoverageUnitBuilder setYangTypes(final List<YangType> yangTypes) {
            this.yangTypes = yangTypes;
            return this;
        }

        public CoverageUnitBuilder setSupportedOperations(final Set<Operation> supportedOperations) {
            this.supportedOperations = supportedOperations;
            return this;
        }

        public CoverageUnit build() {
            return new CoverageUnit(vppApi, javaApi, yangTypes, supportedOperations);
        }
    }
}