summaryrefslogtreecommitdiffstats
path: root/vpp-integration/api-docs/api/src/main/java/io/fd/hc2vpp/docs/api/VppApiMessage.java
blob: 5be743241f7255cf254097470639252495154198 (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
/*
 * 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 static java.util.Objects.requireNonNull;

import java.util.Objects;
import javax.annotation.Nonnull;

/**
 * Represents reference to VPP binary api
 */
public class VppApiMessage {

    /**
     * Name of the api
     */
    private final String name;

    /**
     * fd.io doc link
     */
    // TODO - check if possible to add direct link for specific api
    private final String link;

    public VppApiMessage(@Nonnull final String name, @Nonnull final String link) {
        this.name = requireNonNull(name, "name should not be null");
        this.link = requireNonNull(link, "link should not be null");
    }

    public String getName() {
        return name;
    }

    public String getLink() {
        return link;
    }


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

        final VppApiMessage that = (VppApiMessage) o;

        return Objects.equals(this.name, that.name) && Objects.equals(this.link, that.link);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, link);
    }
}