model/ietf/ietf-type-util/src/main/java/org/opendaylight/mdsal/model/ietf/util/AbstractIetfInetUtil.java

   1 /*
   2  * Copyright (c) 2016 Pantheon Technologies s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.model.ietf.util;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.net.InetAddresses;
  15 import java.net.Inet4Address;
  16 import java.net.Inet6Address;
  17 import java.net.InetAddress;
  18 import java.net.UnknownHostException;
  19 import java.util.AbstractMap.SimpleImmutableEntry;
  20 import java.util.Map.Entry;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.opendaylight.mdsal.binding.spec.reflect.StringValueObjectFactory;
  24
  25 /**
  26  * A set of utility methods to efficiently instantiate various ietf-inet-types DTOs.
  27  */
  28 @Beta
  29 @SuppressWarnings("checkstyle:classTypeParameterName")
  30 public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ extends A6, P6, A, ANZ, P> {
  31     private static final int INET4_LENGTH = 4;
  32     private static final int INET6_LENGTH = 16;
  33
  34     private final StringValueObjectFactory<A4> address4Factory;
  35     private final StringValueObjectFactory<A4NZ> address4NoZoneFactory;
  36     private final StringValueObjectFactory<P4> prefix4Factory;
  37     private final StringValueObjectFactory<A6> address6Factory;
  38     private final StringValueObjectFactory<A6NZ> address6NoZoneFactory;
  39     private final StringValueObjectFactory<P6> prefix6Factory;
  40
  41     protected AbstractIetfInetUtil(final Class<A4> addr4Class, final Class<A4NZ> addr4nzClass,
  42             final Class<P4> prefix4Class, final Class<A6> addr6Class, final Class<A6NZ> addr6nzClass,
  43             final Class<P6> prefix6Class) {
  44         this.address4Factory = StringValueObjectFactory.create(addr4Class, "0.0.0.0");
  45         this.address4NoZoneFactory = StringValueObjectFactory.create(addr4nzClass, "0.0.0.0");
  46         this.prefix4Factory = StringValueObjectFactory.create(prefix4Class, "0.0.0.0/0");
  47         this.address6Factory = StringValueObjectFactory.create(addr6Class, "::0");
  48         this.address6NoZoneFactory = StringValueObjectFactory.create(addr6nzClass, "::0");
  49         this.prefix6Factory = StringValueObjectFactory.create(prefix6Class, "::0/0");
  50     }
  51
  52     protected abstract @NonNull A ipv4Address(@NonNull A4 addr);
  53
  54     protected abstract @NonNull ANZ ipv4AddressNoZone(@NonNull A4NZ addr);
  55
  56     protected abstract @NonNull A ipv6Address(@NonNull A6 addr);
  57
  58     protected abstract @NonNull ANZ ipv6AddressNoZone(@NonNull A6NZ addr);
  59
  60     protected abstract @Nullable A4 maybeIpv4Address(@NonNull A addr);
  61
  62     protected abstract @Nullable A4NZ maybeIpv4AddressNoZone(@NonNull ANZ addr);
  63
  64     protected abstract @Nullable A6 maybeIpv6Address(@NonNull A addr);
  65
  66     protected abstract @Nullable A6NZ maybeIpv6AddressNoZone(@NonNull ANZ addr);
  67
  68     protected abstract @NonNull P ipv4Prefix(@NonNull P4 addr);
  69
  70     protected abstract @NonNull P ipv6Prefix(@NonNull P6 addr);
  71
  72     protected abstract @NonNull String ipv4AddressString(@NonNull A4 addr);
  73
  74     protected abstract @NonNull String ipv6AddressString(@NonNull A6 addr);
  75
  76     protected abstract @NonNull String ipv4PrefixString(@NonNull P4 prefix);
  77
  78     protected abstract @NonNull String ipv6PrefixString(@NonNull P6 prefix);
  79
  80     /**
  81      * Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.
  82      *
  83      * @param bytes 4-byte (IPv4) or 6-byte (IPv6) array
  84      * @return An IpAddress object
  85      * @throws IllegalArgumentException if bytes has length different from 4 or 6
  86      * @throws NullPointerException if bytes is null
  87      */
  88     public final @NonNull A ipAddressFor(final byte @NonNull[] bytes) {
  89         switch (bytes.length) {
  90             case INET4_LENGTH:
  91                 return ipv4Address(ipv4AddressFor(bytes));
  92             case INET6_LENGTH:
  93                 return ipv6Address(ipv6AddressFor(bytes));
  94             default:
  95                 throw new IllegalArgumentException("Invalid array length " + bytes.length);
  96         }
  97     }
  98
  99     public final @NonNull A ipAddressFor(final @NonNull InetAddress addr) {
 100         requireNonNull(addr, "Address must not be null");
 101         if (addr instanceof Inet4Address) {
 102             return ipv4Address(ipv4AddressFor(addr));
 103         } else if (addr instanceof Inet6Address) {
 104             return ipv6Address(ipv6AddressFor(addr));
 105         } else {
 106             throw new IllegalArgumentException("Unhandled address " + addr);
 107         }
 108     }
 109
 110     /**
 111      * Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.
 112      *
 113      * @param bytes 4-byte (IPv4) or 6-byte (IPv6) array
 114      * @return A no-zone IpAddress object
 115      * @throws IllegalArgumentException if bytes has length different from 4 or 6
 116      * @throws NullPointerException if bytes is null
 117      */
 118     public final @NonNull ANZ ipAddressNoZoneFor(final byte @NonNull[] bytes) {
 119         switch (bytes.length) {
 120             case INET4_LENGTH:
 121                 return ipv4AddressNoZone(ipv4AddressNoZoneFor(bytes));
 122             case INET6_LENGTH:
 123                 return ipv6AddressNoZone(ipv6AddressNoZoneFor(bytes));
 124             default:
 125                 throw new IllegalArgumentException("Invalid array length " + bytes.length);
 126         }
 127     }
 128
 129     public final @NonNull ANZ ipAddressNoZoneFor(final @NonNull InetAddress addr) {
 130         requireNonNull(addr, "Address must not be null");
 131         if (addr instanceof Inet4Address) {
 132             return ipv4AddressNoZone(ipv4AddressNoZoneFor(addr));
 133         } else if (addr instanceof Inet6Address) {
 134             return ipv6AddressNoZone(ipv6AddressNoZoneFor(addr));
 135         } else {
 136             throw new IllegalArgumentException("Unhandled address " + addr);
 137         }
 138     }
 139
 140     /**
 141      * Create an IpPrefix by combining the address with a mask. The address
 142      * bytes are interpreted as an address and the specified mask is concatenated to
 143      * it. The address bytes are not masked.
 144      *
 145      * @param bytes Input address as a 4-byte (IPv4) or 16-byte (IPv6) array
 146      * @param mask Prefix mask
 147      * @return An IpPrefix object
 148      * @throws IllegalArgumentException if bytes has length different from 4 or 16 or if mask is not
 149      *         in range 0-32 or 0-128 respectively
 150      * @throws NullPointerException if bytes is null
 151      */
 152     public final @NonNull P ipPrefixFor(final byte @NonNull[] bytes, final int mask) {
 153         switch (bytes.length) {
 154             case INET4_LENGTH:
 155                 return ipv4Prefix(ipv4PrefixFor(bytes, mask));
 156             case INET6_LENGTH:
 157                 return ipv6Prefix(ipv6PrefixFor(bytes, mask));
 158             default:
 159                 throw new IllegalArgumentException("Invalid array length " + bytes.length);
 160         }
 161     }
 162
 163     public final @NonNull P ipPrefixFor(final @NonNull InetAddress addr, final int mask) {
 164         requireNonNull(addr, "Address must not be null");
 165         if (addr instanceof Inet4Address) {
 166             return ipv4Prefix(ipv4PrefixFor(addr, mask));
 167         } else if (addr instanceof Inet6Address) {
 168             return ipv6Prefix(ipv6PrefixFor(addr, mask));
 169         } else {
 170             throw new IllegalArgumentException("Unhandled address " + addr);
 171         }
 172     }
 173
 174     public final @NonNull InetAddress inetAddressFor(final @NonNull A addr) {
 175         final A4 v4 = maybeIpv4Address(addr);
 176         if (v4 != null) {
 177             return inet4AddressFor(v4);
 178         }
 179         final A6 v6 = maybeIpv6Address(addr);
 180         checkArgument(v6 != null, "Address %s is neither IPv4 nor IPv6", addr);
 181         return inet6AddressFor(v6);
 182     }
 183
 184     public final @NonNull InetAddress inetAddressForNoZone(final @NonNull ANZ addr) {
 185         final A4NZ v4 = maybeIpv4AddressNoZone(addr);
 186         if (v4 != null) {
 187             return inet4AddressForNoZone(v4);
 188         }
 189         final A6NZ v6 = maybeIpv6AddressNoZone(addr);
 190         checkArgument(v6 != null, "Address %s is neither IPv4 nor IPv6", addr);
 191         return inet6AddressForNoZone(v6);
 192     }
 193
 194
 195     public final @NonNull Inet4Address inet4AddressFor(final @NonNull A4 addr) {
 196         try {
 197             return (Inet4Address) InetAddress.getByAddress(ipv4AddressBytes(addr));
 198         } catch (UnknownHostException e) {
 199             throw new IllegalArgumentException("Invalid address " + addr, e);
 200         }
 201     }
 202
 203     public final @NonNull Inet4Address inet4AddressForNoZone(final @NonNull A4NZ addr) {
 204         try {
 205             return (Inet4Address) InetAddress.getByAddress(ipv4AddressNoZoneBytes(addr));
 206         } catch (UnknownHostException e) {
 207             throw new IllegalArgumentException("Invalid address " + addr, e);
 208         }
 209     }
 210
 211     public final @NonNull Inet6Address inet6AddressFor(final @NonNull A6 addr) {
 212         try {
 213             return (Inet6Address) InetAddress.getByAddress(ipv6AddressBytes(addr));
 214         } catch (UnknownHostException e) {
 215             throw new IllegalArgumentException("Invalid address " + addr, e);
 216         }
 217     }
 218
 219     public final @NonNull Inet6Address inet6AddressForNoZone(final @NonNull A6NZ addr) {
 220         try {
 221             return (Inet6Address) InetAddress.getByAddress(ipv6AddressNoZoneBytes(addr));
 222         } catch (UnknownHostException e) {
 223             throw new IllegalArgumentException("Invalid address " + addr, e);
 224         }
 225     }
 226
 227     /**
 228      * Create an Ipv4Address by interpreting input bytes as an IPv4 address.
 229      *
 230      * @param bytes 4-byte array
 231      * @return An Ipv4Address object
 232      * @throws IllegalArgumentException if bytes has length different from 4
 233      * @throws NullPointerException if bytes is null
 234      */
 235     public final @NonNull A4 ipv4AddressFor(final byte @NonNull[] bytes) {
 236         return address4Factory.newInstance(addressStringV4(bytes));
 237     }
 238
 239     /**
 240      * Create an Ipv4Address by interpreting an {@link Inet4Address}.
 241      *
 242      * @param addr An {@link Inet4Address}
 243      * @return An Ipv4Address object
 244      * @throws IllegalArgumentException if addr is not an {@link Inet4Address}
 245      * @throws NullPointerException if addr is null
 246      */
 247     public final @NonNull A4 ipv4AddressFor(final @NonNull InetAddress addr) {
 248         requireNonNull(addr, "Address must not be null");
 249         checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
 250         return address4Factory.newInstance(addr.getHostAddress());
 251     }
 252
 253     /**
 254      * Create an Ipv4Address by interpreting input 32 bits as an IPv4 address in big-endian format.
 255      *
 256      * @param bits 32 bits, big endian
 257      * @return An Ipv4Address object
 258      */
 259     public final @NonNull A4 ipv4AddressFor(final int bits) {
 260         return address4Factory.newInstance(addressString(bits));
 261     }
 262
 263     /**
 264      * Create an Ipv4AddressNoZone by interpreting input bytes as an IPv4 address.
 265      *
 266      * @param bytes 4-byte array
 267      * @return An Ipv4AddressNoZone object
 268      * @throws IllegalArgumentException if bytes has length different from 4
 269      * @throws NullPointerException if bytes is null
 270      */
 271     public final @NonNull A4NZ ipv4AddressNoZoneFor(final byte @NonNull[] bytes) {
 272         return address4NoZoneFactory.newInstance(addressStringV4(bytes));
 273     }
 274
 275     /**
 276      * Create an Ipv4AddressNoZone by interpreting an {@link Inet4Address}.
 277      *
 278      * @param addr An {@link Inet4Address}
 279      * @return An Ipv4AddressNoZone object
 280      * @throws IllegalArgumentException if addr is not an {@link Inet4Address}
 281      * @throws NullPointerException if addr is null
 282      */
 283     public final @NonNull A4NZ ipv4AddressNoZoneFor(final @NonNull InetAddress addr) {
 284         requireNonNull(addr, "Address must not be null");
 285         checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
 286         return address4NoZoneFactory.newInstance(addr.getHostAddress());
 287     }
 288
 289     /**
 290      * Create an Ipv4AddressNoZone by interpreting input 32 bits as an IPv4 address in big-endian format.
 291      *
 292      * @param bits 32 bits, big endian
 293      * @return An Ipv4AddressNoZone object
 294      */
 295     public final @NonNull A4NZ ipv4AddressNoZoneFor(final int bits) {
 296         return address4NoZoneFactory.newInstance(addressString(bits));
 297     }
 298
 299     public final @NonNull A4 ipv4AddressFrom(final @NonNull P4 prefix) {
 300         return prefixToAddress(address4Factory, ipv4PrefixString(prefix));
 301     }
 302
 303     public final @NonNull A4NZ ipv4AddressNoZoneFrom(final @NonNull P4 prefix) {
 304         return prefixToAddress(address4NoZoneFactory, ipv4PrefixString(prefix));
 305     }
 306
 307     public final byte @NonNull[] ipv4AddressBytes(final @NonNull A4 addr) {
 308         /*
 309          * This implementation relies heavily on the input string having been validated to comply with
 310          * the Ipv4Address pattern, which may include a zone index.
 311          */
 312         final String str = ipv4AddressString(addr);
 313         final int percent = str.indexOf('%');
 314         return ipv4StringBytes(str, percent == -1 ? str.length() : percent);
 315     }
 316
 317     public final int ipv4AddressBits(final @NonNull A4 addr) {
 318         final String str = ipv4AddressString(addr);
 319         final int percent = str.indexOf('%');
 320         return ipv4StringBits(str, percent == -1 ? str.length() : percent);
 321     }
 322
 323     public final byte @NonNull[] ipv4AddressNoZoneBytes(final @NonNull A4NZ addr) {
 324         /*
 325          * This implementation relies heavily on the input string having been validated to comply with
 326          * the Ipv4AddressNoZone pattern, which must not include a zone index.
 327          */
 328         final String str = ipv4AddressString(addr);
 329         return ipv4StringBytes(str, str.length());
 330     }
 331
 332     public final int ipv4AddressNoZoneBits(final @NonNull A4NZ addr) {
 333         final String str = ipv4AddressString(addr);
 334         return ipv4StringBits(str, str.length());
 335     }
 336
 337     private static byte @NonNull[] ipv4StringBytes(final String str, final int limit) {
 338         final byte[] bytes = new byte[INET4_LENGTH];
 339         Ipv4Utils.fillIpv4Bytes(bytes, 0, str, 0, limit);
 340         return bytes;
 341     }
 342
 343     private static int ipv4StringBits(final String str, final int limit) {
 344         int prev = 0;
 345         int current = 0;
 346         for (int i = 0, shift = 24; i < limit; ++i) {
 347             final char c = str.charAt(i);
 348             if (c == '.') {
 349                 prev |= current << shift;
 350                 shift -= 8;
 351                 current = 0;
 352             } else {
 353                 current = 10 * current + c - '0';
 354             }
 355         }
 356         return prev | current;
 357     }
 358
 359     /**
 360      * Create a /32 Ipv4Prefix by interpreting input bytes as an IPv4 address.
 361      *
 362      * @param bytes four-byte array
 363      * @return An Ipv4Prefix object
 364      * @throws IllegalArgumentException if bytes has length different from 4
 365      * @throws NullPointerException if bytes is null
 366      */
 367     public final @NonNull P4 ipv4PrefixFor(final byte @NonNull[] bytes) {
 368         return prefix4Factory.newInstance(prefixStringV4(bytes));
 369     }
 370
 371     /**
 372      * Create a Ipv4Prefix by combining the address with a mask. The address
 373      * bytes are interpreted as an address and the specified mask is concatenated to
 374      * it. The address bytes are not masked, hence input <code>address = { 1, 2, 3, 4 }</code>
 375      * and <code>mask=24</code> will result in <code>1.2.3.4/24</code>.
 376      *
 377      * @param address Input address as a 4-byte array
 378      * @param mask Prefix mask
 379      * @return An Ipv4Prefix object
 380      * @throws IllegalArgumentException if bytes has length different from 4 or if mask is not in range 0-32
 381      * @throws NullPointerException if bytes is null
 382      */
 383     public final @NonNull P4 ipv4PrefixFor(final byte @NonNull[] address, final int mask) {
 384         return prefix4Factory.newInstance(prefixStringV4(address, mask));
 385     }
 386
 387     /**
 388      * Create a /32 Ipv4Prefix for an {@link Inet4Address}.
 389      *
 390      * @param addr An {@link Inet4Address}
 391      * @return An Ipv4Prefix object
 392      * @throws IllegalArgumentException if addr is not an Inet4Address
 393      * @throws NullPointerException if addr is null
 394      */
 395     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr) {
 396         requireNonNull(addr, "Address must not be null");
 397         checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
 398         return prefix4Factory.newInstance(addr.getHostAddress() + "/32");
 399     }
 400
 401     /**
 402      * Create a Ipv4Prefix by combining the address with a mask. The address bytes are not masked.
 403      *
 404      * @param addr An {@link Inet4Address}
 405      * @param mask Prefix mask
 406      * @return An Ipv4Prefix object
 407      * @throws IllegalArgumentException if addr is not an Inet4Address or if mask is not in range 0-32
 408      * @throws NullPointerException if addr is null
 409      */
 410     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr, final int mask) {
 411         requireNonNull(addr, "Address must not be null");
 412         checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
 413         return newIpv4Prefix(addr.getHostAddress(), mask);
 414     }
 415
 416     public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr) {
 417         requireNonNull(addr, "Address must not be null");
 418         return prefix4Factory.newInstance(stripZone(ipv4AddressString(addr)) + "/32");
 419     }
 420
 421     public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr, final int mask) {
 422         requireNonNull(addr, "Address must not be null");
 423         return newIpv4Prefix(stripZone(ipv4AddressString(addr)), mask);
 424     }
 425
 426     public final @NonNull P4 ipv4PrefixForNoZone(final @NonNull A4NZ addr) {
 427         requireNonNull(addr, "Address must not be null");
 428         return prefix4Factory.newInstance(ipv4AddressString(addr) + "/32");
 429     }
 430
 431     public final @NonNull P4 ipv4PrefixForNoZone(final @NonNull A4NZ addr, final int mask) {
 432         requireNonNull(addr, "Address must not be null");
 433         return newIpv4Prefix(ipv4AddressString(addr), mask);
 434     }
 435
 436     public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] address, final int mask) {
 437         if (mask == 0) {
 438             // Easy case, reuse the template
 439             return prefix4Factory.getTemplate();
 440         }
 441
 442         return v4PrefixForShort(address, 0, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
 443     }
 444
 445     public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
 446         if (mask == 0) {
 447             // Easy case, reuse the template
 448             return prefix4Factory.getTemplate();
 449         }
 450
 451         return v4PrefixForShort(array, startOffset, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
 452     }
 453
 454     private static String stripZone(final String str) {
 455         final int percent = str.indexOf('%');
 456         return percent == -1 ? str : str.substring(0, percent);
 457     }
 458
 459     private @NonNull P4 newIpv4Prefix(final String addr, final int mask) {
 460         checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
 461         return prefix4Factory.newInstance(addr + '/' + mask);
 462     }
 463
 464     public final @NonNull Entry<A4, Integer> splitIpv4Prefix(final @NonNull P4 prefix) {
 465         return splitPrefix(address4Factory, ipv4PrefixString(prefix));
 466     }
 467
 468     public final @NonNull Entry<A4NZ, Integer> splitIpv4PrefixNoZone(final @NonNull P4 prefix) {
 469         return splitPrefix(address4NoZoneFactory, ipv4PrefixString(prefix));
 470     }
 471
 472     public final byte @NonNull[] ipv4PrefixToBytes(final @NonNull P4 prefix) {
 473         final String str = ipv4PrefixString(prefix);
 474         final int slash = str.lastIndexOf('/');
 475
 476         final byte[] bytes = new byte[INET4_LENGTH + 1];
 477         Ipv4Utils.fillIpv4Bytes(bytes, 0, str, 0, slash);
 478         bytes[INET4_LENGTH] = (byte)Integer.parseInt(str.substring(slash + 1), 10);
 479         return bytes;
 480     }
 481
 482     /**
 483      * Create an Ipv6Address by interpreting input bytes as an IPv6 address.
 484      *
 485      * @param bytes 16-byte array
 486      * @return An Ipv6Address object
 487      * @throws IllegalArgumentException if bytes has length different from 16
 488      * @throws NullPointerException if bytes is null
 489      */
 490     public final @NonNull A6 ipv6AddressFor(final byte @NonNull[] bytes) {
 491         return address6Factory.newInstance(addressStringV6(bytes));
 492     }
 493
 494     /**
 495      * Create an Ipv6Address by interpreting an {@link Inet6Address}.
 496      *
 497      * @param addr An {@link Inet6Address}
 498      * @return An Ipv6Address object
 499      * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
 500      * @throws NullPointerException if addr is null
 501      */
 502     public final @NonNull A6 ipv6AddressFor(final @NonNull InetAddress addr) {
 503         requireNonNull(addr, "Address must not be null");
 504         checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
 505         return address6Factory.newInstance(addressStringV6(addr));
 506     }
 507
 508     /**
 509      * Create an Ipv6AddressNoZone by interpreting input bytes as an IPv6 address.
 510      *
 511      * @param bytes 16-byte array
 512      * @return An Ipv6Address object
 513      * @throws IllegalArgumentException if bytes has length different from 16
 514      * @throws NullPointerException if bytes is null
 515      */
 516     public final @NonNull A6NZ ipv6AddressNoZoneFor(final byte @NonNull[] bytes) {
 517         return address6NoZoneFactory.newInstance(addressStringV6(bytes));
 518     }
 519
 520     /**
 521      * Create an Ipv6AddressNoZone by interpreting an {@link Inet6Address}.
 522      *
 523      * @param addr An {@link Inet6Address}
 524      * @return An Ipv6AddressNoZone object
 525      * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
 526      * @throws NullPointerException if addr is null
 527      */
 528     public final @NonNull A6NZ ipv6AddressNoZoneFor(final @NonNull InetAddress addr) {
 529         requireNonNull(addr, "Address must not be null");
 530         checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
 531         return address6NoZoneFactory.newInstance(addressStringV6(addr));
 532     }
 533
 534     public final @NonNull A6 ipv6AddressFrom(final @NonNull P6 prefix) {
 535         return prefixToAddress(address6Factory, ipv6PrefixString(prefix));
 536     }
 537
 538     public final @NonNull A6NZ ipv6AddressNoZoneFrom(final @NonNull P6 prefix) {
 539         return prefixToAddress(address6NoZoneFactory, ipv6PrefixString(prefix));
 540     }
 541
 542     public final byte @NonNull[] ipv6AddressBytes(final @NonNull A6 addr) {
 543         final String str = ipv6AddressString(addr);
 544         final int percent = str.indexOf('%');
 545         return ipv6StringBytes(str, percent == -1 ? str.length() : percent);
 546     }
 547
 548     public final byte @NonNull[] ipv6AddressNoZoneBytes(final @NonNull A6NZ addr) {
 549         final String str = ipv6AddressString(addr);
 550         return ipv6StringBytes(str, str.length());
 551     }
 552
 553     private static byte @NonNull[] ipv6StringBytes(final @NonNull String str, final int limit) {
 554         final byte[] bytes = new byte[INET6_LENGTH];
 555         Ipv6Utils.fillIpv6Bytes(bytes, str, limit);
 556         return bytes;
 557     }
 558
 559     /**
 560      * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
 561      *
 562      * @param bytes four-byte array
 563      * @return An Ipv6Prefix object
 564      * @throws IllegalArgumentException if bytes has length different from 16
 565      * @throws NullPointerException if bytes is null
 566      */
 567     public final @NonNull P6 ipv6PrefixFor(final byte @NonNull[] bytes) {
 568         return prefix6Factory.newInstance(addressStringV6(bytes) + "/128");
 569     }
 570
 571     /**
 572      * Create a Ipv6Prefix by combining the address with a mask. The address
 573      * bytes are interpreted as an address and the specified mask is concatenated to
 574      * it. The address bytes are not masked.
 575      *
 576      * @param address Input address as a 16-byte array
 577      * @param mask Prefix mask
 578      * @return An Ipv6Prefix object
 579      * @throws IllegalArgumentException if bytes has length different from 16 or if mask is not in range 0-128
 580      * @throws NullPointerException if bytes is null
 581      */
 582     public final @NonNull P6 ipv6PrefixFor(final byte @NonNull[] address, final int mask) {
 583         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 584         return prefix6Factory.newInstance(addressStringV6(address) + '/' + mask);
 585     }
 586
 587     /**
 588      * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv4 address.
 589      *
 590      * @param addr an {@link Inet6Address}
 591      * @return An Ipv6Prefix object
 592      * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
 593      * @throws NullPointerException if addr is null
 594      */
 595     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr) {
 596         return prefix6Factory.newInstance(addressStringV6(addr) + "/128");
 597     }
 598
 599     /**
 600      * Create a Ipv6Prefix by combining the address with a mask. The address
 601      * bytes are interpreted as an address and the specified mask is concatenated to
 602      * it. The address bytes are not masked.
 603      *
 604      * @param addr Input address
 605      * @param mask Prefix mask
 606      * @return An Ipv6Prefix object
 607      * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
 608      * @throws NullPointerException if addr is null
 609      */
 610     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr, final int mask) {
 611         requireNonNull(addr, "Address must not be null");
 612         checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
 613         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 614         return prefix6Factory.newInstance(addressStringV6(addr) + '/' + mask);
 615     }
 616
 617     public final @NonNull P6 ipv6PrefixFor(final @NonNull A6 addr) {
 618         requireNonNull(addr, "Address must not be null");
 619         return prefix6Factory.newInstance(stripZone(ipv6AddressString(addr)) + "/128");
 620     }
 621
 622     public final @NonNull P6 ipv6PrefixFor(final @NonNull A6 addr, final int mask) {
 623         requireNonNull(addr, "Address must not be null");
 624         return newIpv6Prefix(stripZone(ipv6AddressString(addr)), mask);
 625     }
 626
 627     public final @NonNull P6 ipv6PrefixForNoZone(final @NonNull A6NZ addr) {
 628         requireNonNull(addr, "Address must not be null");
 629         return prefix6Factory.newInstance(ipv6AddressString(addr) + "/128");
 630     }
 631
 632     public final @NonNull P6 ipv6PrefixForNoZone(final @NonNull A6NZ addr, final int mask) {
 633         requireNonNull(addr, "Address must not be null");
 634         return newIpv6Prefix(ipv6AddressString(addr), mask);
 635     }
 636
 637     public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] address, final int mask) {
 638         return ipv6PrefixForShort(address, 0, mask);
 639     }
 640
 641     public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
 642         if (mask == 0) {
 643             // Easy case, reuse the template
 644             return prefix6Factory.getTemplate();
 645         }
 646
 647         checkArgument(mask > 0 && mask <= 128, "Invalid mask %s", mask);
 648         final int size = mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1);
 649
 650         // Until we can instantiate an IPv6 address for a partial array, use a temporary buffer
 651         byte[] tmp = new byte[INET6_LENGTH];
 652         System.arraycopy(array, startOffset, tmp, 0, size);
 653         return ipv6PrefixFor(tmp, mask);
 654     }
 655
 656     private P6 newIpv6Prefix(final String addr, final int mask) {
 657         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 658         return prefix6Factory.newInstance(addr + '/' + mask);
 659     }
 660
 661     public final @NonNull Entry<A6, Integer> splitIpv6Prefix(final @NonNull P6 prefix) {
 662         return splitPrefix(address6Factory, ipv6PrefixString(prefix));
 663     }
 664
 665     public final @NonNull Entry<A6NZ, Integer> splitIpv6PrefixNoZone(final @NonNull P6 prefix) {
 666         return splitPrefix(address6NoZoneFactory, ipv6PrefixString(prefix));
 667     }
 668
 669     private static <T> @NonNull T prefixToAddress(final StringValueObjectFactory<T> factory, final String str) {
 670         return factory.newInstance(str.substring(0, str.lastIndexOf('/')));
 671     }
 672
 673     private static <T> @NonNull Entry<T, Integer> splitPrefix(final StringValueObjectFactory<T> factory,
 674             final String str) {
 675         final int slash = str.lastIndexOf('/');
 676         return new SimpleImmutableEntry<>(factory.newInstance(str.substring(0, slash)),
 677                 Integer.valueOf(str.substring(slash + 1)));
 678     }
 679
 680     public final byte @NonNull[] ipv6PrefixToBytes(final @NonNull P6 prefix) {
 681         final String str = ipv6PrefixString(prefix);
 682         final byte[] bytes = new byte[INET6_LENGTH + 1];
 683         final int slash = str.lastIndexOf('/');
 684         Ipv6Utils.fillIpv6Bytes(bytes, str, slash);
 685         bytes[INET6_LENGTH] = (byte)Integer.parseInt(str.substring(slash + 1), 10);
 686         return bytes;
 687     }
 688
 689     private static void appendIpv4String(final StringBuilder sb, final byte @NonNull[] bytes) {
 690         checkArgument(bytes.length == INET4_LENGTH, "IPv4 address length is 4 bytes");
 691
 692         sb.append(Byte.toUnsignedInt(bytes[0]));
 693         for (int i = 1; i < INET4_LENGTH; ++i) {
 694             sb.append('.').append(Byte.toUnsignedInt(bytes[i]));
 695         }
 696     }
 697
 698     private static String addressString(final int bits) {
 699         return new StringBuilder(15)
 700                 .append(bits >>> 24).append('.')
 701                 .append(bits >>> 16 & 0xFF).append('.')
 702                 .append(bits >>> 8 & 0xFF).append('.')
 703                 .append(bits & 0xFF)
 704                 .toString();
 705     }
 706
 707     static String addressStringV4(final byte @NonNull[] bytes) {
 708         final StringBuilder sb = new StringBuilder(15);
 709         appendIpv4String(sb, bytes);
 710         return sb.toString();
 711     }
 712
 713     private static String addressStringV6(final byte @NonNull[] bytes) {
 714         checkArgument(bytes.length == INET6_LENGTH, "IPv6 address length is 16 bytes");
 715
 716         try {
 717             return addressStringV6(Inet6Address.getByAddress(bytes));
 718         } catch (UnknownHostException e) {
 719             throw new IllegalArgumentException(String.format("Invalid input %s", bytes), e);
 720         }
 721     }
 722
 723     private static String addressStringV6(final InetAddress addr) {
 724         return InetAddresses.toAddrString(addr);
 725     }
 726
 727     private static String prefixStringV4(final byte @NonNull[] bytes) {
 728         final StringBuilder sb = new StringBuilder(18);
 729         appendIpv4String(sb, bytes);
 730         return sb.append("/32").toString();
 731     }
 732
 733     private static String prefixStringV4(final byte @NonNull[] bytes, final int mask) {
 734         checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
 735
 736         final StringBuilder sb = new StringBuilder(18);
 737         appendIpv4String(sb, bytes);
 738         return sb.append('/').append(mask).toString();
 739     }
 740
 741     private P4 v4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int size, final int mask) {
 742         if (startOffset == 0 && size == INET4_LENGTH && array.length == INET4_LENGTH) {
 743             // Easy case, fall back to non-short
 744             return ipv4PrefixFor(array, mask);
 745         }
 746
 747         final StringBuilder sb = new StringBuilder(18);
 748
 749         // Add from address
 750         sb.append(Byte.toUnsignedInt(array[startOffset]));
 751         for (int i = 1; i < size; i++) {
 752             sb.append('.').append(Byte.toUnsignedInt(array[startOffset + i]));
 753         }
 754
 755         // Add zeros
 756         for (int i = size; i < INET4_LENGTH; i++) {
 757             sb.append(".0");
 758         }
 759
 760         // Add mask
 761         checkArgument(mask > 0 && mask <= 32, "Invalid mask %s", mask);
 762         sb.append('/').append(mask);
 763
 764         return prefix4Factory.newInstance(sb.toString());
 765     }
 766 }