com.ionos.network.commons.address.HexadecimalAddressFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-network Show documentation

IP network related classes

There is a newer version: 0.14.0

package com.ionos.network.commons.address;

import java.io.IOException;

/**
 * Formats an address to a text form in a customizable hexadecimal
 * notation in fixed length.
 * @param  the type of address to format.
 * @see HexadecimalAddressParser
 * @author Stephan Fuhrmann
 * */
public final class HexadecimalAddressFormat
        extends AbstractAddressFormat {

    /** The character to use as a separator. */
    private final char separator;

    /** The interval in characters for separators to occur. */
    private final int separatorInterval;

    /**
     * Constructor of an instance.
     * @param inSeparator the character to separate the parts with.
     *                    Example: {@code ab:cd:ef:12:34:45}
     *                    has the separator character {@code ':'}.
     * @param inSeparatorInterval the number of hex digits that form the parts.
     *                            Example:
     *                            {@code ab:cd:ef:12:34:45} has the
     *                            separator interval {@code 2}.
     * @throws IllegalArgumentException if the
     * {@code separatorInterval is equal or less than 0}.
     */
    public HexadecimalAddressFormat(final char inSeparator,
                                    final int inSeparatorInterval) {
        this.separator = inSeparator;
        if (inSeparatorInterval <= 0) {
            throw new IllegalArgumentException(
                    "separatorInterval must be > 0");
        }
        this.separatorInterval = inSeparatorInterval;
    }

    @Override
    public  A format(
            final T address,
            final A toAppendTo)
            throws IOException {
        byte[] addressBytes = AbstractAddress.getBytesForReading(address);

        int charIndex = 0;
        for (int i = 0; i < addressBytes.length; i++) {
            int val = addressBytes[i];

            if (charIndex != 0 && charIndex % separatorInterval == 0) {
                toAppendTo.append(separator);
            }

            toAppendTo.append(BitsAndBytes.toHexDigit(
                    val >>> BitsAndBytes.BITS_PER_NIBBLE
                            & BitsAndBytes.BIT_MASK_NIBBLE));
            charIndex++;

            if (charIndex % separatorInterval == 0) {
                toAppendTo.append(separator);
            }
            toAppendTo.append(BitsAndBytes.toHexDigit(
                    val & BitsAndBytes.BIT_MASK_NIBBLE));
            charIndex++;
        }

        return toAppendTo;
    }
}