com.hedera.hashgraph.sdk.IPv4Address Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
/*-
 *
 * Hedera Java SDK
 *
 * Copyright (C) 2020 - 2024 Hedera Hashgraph, LLC
 *
 * 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 com.hedera.hashgraph.sdk;

import com.google.protobuf.ByteString;

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

/**
 * A simplified representation of a 32 bit IPv4Address.
 */
public class IPv4Address implements Cloneable {
    /**
     * Represents the first 16 bits of the IPv4Address.
     */
    @Nullable
    IPv4AddressPart network;
    /**
     * Represents the last 16 bits of the IPv4Address.
     */
    @Nullable
    IPv4AddressPart host;

    /**
     * Constructor.
     */
    public IPv4Address() {
    }

    /**
     * Create an ipv4address from a protobuf byte string.
     *
     * @param address                   the byte string
     * @return                          the new ipv4address
     */
    static IPv4Address fromProtobuf(ByteString address) {
        return new IPv4Address()
            .setNetwork(new IPv4AddressPart()
                .setLeft(address.byteAt(0))
                .setRight(address.byteAt(1))
            )
            .setHost(new IPv4AddressPart()
                .setLeft(address.byteAt(2))
                .setRight(address.byteAt(3))
            );
    }

    /**
     * Extract the network portion of the address.
     *
     * @return                          the network portion of the address
     */
    @Nullable
    public IPv4AddressPart getNetwork() {
        return network;
    }

    /**
     * Assign the network portion of the address.
     *
     * @param network                   the network portion of the address
     * @return {@code this}
     */
    public IPv4Address setNetwork(IPv4AddressPart network) {
        this.network = network;
        return this;
    }

    /**
     * Extract the host portion of the address.
     *
     * @return                          the host portion of the address
     */
    @Nullable
    public IPv4AddressPart getHost() {
        return host;
    }

    /**
     * Assign the host portion of the address.
     *
     * @param host                      the host portion of the address
     * @return {@code this}
     */
    public IPv4Address setHost(IPv4AddressPart host) {
        this.host = host;
        return this;
    }

    /**
     * Create the protobuf.
     *
     * @return                          the protobuf representation
     */
    ByteString toProtobuf() {
        return ByteString.copyFrom(new byte[]{Objects.requireNonNull(network).left, network.right, Objects.requireNonNull(host).left, host.right});
    }

    /**
     * Extract the string representation.
     *
     * @return                          the string representation
     */
    @Override
    public String toString() {
        return Objects.requireNonNull(network) + "." + Objects.requireNonNull(host);
    }

    @Override
    public IPv4Address clone() {
        try {
            IPv4Address clone = (IPv4Address) super.clone();
            clone.host = host != null ? host.clone() : null;
            clone.network = network != null ? network.clone() : null;
            return clone;
        } catch (CloneNotSupportedException e) {
            throw new AssertionError();
        }
    }
}