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         return address4Factory.newInstance(addressStringV4(addr));
 249     }
 250
 251     /**
 252      * Create an Ipv4Address by interpreting input 32 bits as an IPv4 address in big-endian format.
 253      *
 254      * @param bits 32 bits, big endian
 255      * @return An Ipv4Address object
 256      */
 257     public final @NonNull A4 ipv4AddressFor(final int bits) {
 258         return address4Factory.newInstance(Ipv4Utils.addressString(bits));
 259     }
 260
 261     /**
 262      * Create an Ipv4AddressNoZone by interpreting input bytes as an IPv4 address.
 263      *
 264      * @param bytes 4-byte array
 265      * @return An Ipv4AddressNoZone object
 266      * @throws IllegalArgumentException if bytes has length different from 4
 267      * @throws NullPointerException if bytes is null
 268      */
 269     public final @NonNull A4NZ ipv4AddressNoZoneFor(final byte @NonNull[] bytes) {
 270         return address4NoZoneFactory.newInstance(addressStringV4(bytes));
 271     }
 272
 273     /**
 274      * Create an Ipv4AddressNoZone by interpreting an {@link Inet4Address}.
 275      *
 276      * @param addr An {@link Inet4Address}
 277      * @return An Ipv4AddressNoZone object
 278      * @throws IllegalArgumentException if addr is not an {@link Inet4Address}
 279      * @throws NullPointerException if addr is null
 280      */
 281     public final @NonNull A4NZ ipv4AddressNoZoneFor(final @NonNull InetAddress addr) {
 282         return address4NoZoneFactory.newInstance(addressStringV4(addr));
 283     }
 284
 285     /**
 286      * Create an Ipv4AddressNoZone by interpreting input 32 bits as an IPv4 address in big-endian format.
 287      *
 288      * @param bits 32 bits, big endian
 289      * @return An Ipv4AddressNoZone object
 290      */
 291     public final @NonNull A4NZ ipv4AddressNoZoneFor(final int bits) {
 292         return address4NoZoneFactory.newInstance(Ipv4Utils.addressString(bits));
 293     }
 294
 295     public final @NonNull A4 ipv4AddressFrom(final @NonNull P4 prefix) {
 296         return prefixToAddress(address4Factory, ipv4PrefixString(prefix));
 297     }
 298
 299     public final @NonNull A4NZ ipv4AddressNoZoneFrom(final @NonNull P4 prefix) {
 300         return prefixToAddress(address4NoZoneFactory, ipv4PrefixString(prefix));
 301     }
 302
 303     public final byte @NonNull[] ipv4AddressBytes(final @NonNull A4 addr) {
 304         /*
 305          * This implementation relies heavily on the input string having been validated to comply with
 306          * the Ipv4Address pattern, which may include a zone index.
 307          */
 308         final String str = ipv4AddressString(addr);
 309         final int percent = str.indexOf('%');
 310         return Ipv4Utils.addressBytes(str, percent == -1 ? str.length() : percent);
 311     }
 312
 313     public final int ipv4AddressBits(final @NonNull A4 addr) {
 314         final String str = ipv4AddressString(addr);
 315         final int percent = str.indexOf('%');
 316         return Ipv4Utils.addressBits(str, percent == -1 ? str.length() : percent);
 317     }
 318
 319     public final byte @NonNull[] ipv4AddressNoZoneBytes(final @NonNull A4NZ addr) {
 320         /*
 321          * This implementation relies heavily on the input string having been validated to comply with
 322          * the Ipv4AddressNoZone pattern, which must not include a zone index.
 323          */
 324         final String str = ipv4AddressString(addr);
 325         return Ipv4Utils.addressBytes(str, str.length());
 326     }
 327
 328     public final int ipv4AddressNoZoneBits(final @NonNull A4NZ addr) {
 329         final String str = ipv4AddressString(addr);
 330         return Ipv4Utils.addressBits(str, str.length());
 331     }
 332
 333     /**
 334      * Create a /32 Ipv4Prefix by interpreting input bytes as an IPv4 address.
 335      *
 336      * @param bytes four-byte array
 337      * @return An Ipv4Prefix object
 338      * @throws IllegalArgumentException if bytes has length different from 4
 339      * @throws NullPointerException if bytes is null
 340      */
 341     public final @NonNull P4 ipv4PrefixFor(final byte @NonNull[] bytes) {
 342         return prefix4Factory.newInstance(prefixStringV4(bytes));
 343     }
 344
 345     /**
 346      * Create a Ipv4Prefix by combining the address with a mask. The address
 347      * bytes are interpreted as an address and the specified mask is concatenated to
 348      * it. The address bytes are not masked, hence input <code>address = { 1, 2, 3, 4 }</code>
 349      * and <code>mask=24</code> will result in <code>1.2.3.4/24</code>.
 350      *
 351      * @param address Input address as a 4-byte array
 352      * @param mask Prefix mask
 353      * @return An Ipv4Prefix object
 354      * @throws IllegalArgumentException if bytes has length different from 4 or if mask is not in range 0-32
 355      * @throws NullPointerException if bytes is null
 356      */
 357     public final @NonNull P4 ipv4PrefixFor(final byte @NonNull[] address, final int mask) {
 358         return prefix4Factory.newInstance(prefixStringV4(address, mask));
 359     }
 360
 361     /**
 362      * Create a /32 Ipv4Prefix for an {@link Inet4Address}.
 363      *
 364      * @param addr An {@link Inet4Address}
 365      * @return An Ipv4Prefix object
 366      * @throws IllegalArgumentException if addr is not an Inet4Address
 367      * @throws NullPointerException if addr is null
 368      */
 369     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr) {
 370         return prefix4Factory.newInstance(addressStringV4(addr) + "/32");
 371     }
 372
 373     /**
 374      * Create a Ipv4Prefix by combining the address with a mask. The address bytes are not masked.
 375      *
 376      * @param addr An {@link Inet4Address}
 377      * @param mask Prefix mask
 378      * @return An Ipv4Prefix object
 379      * @throws IllegalArgumentException if addr is not an Inet4Address or if mask is not in range 0-32
 380      * @throws NullPointerException if addr is null
 381      */
 382     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr, final int mask) {
 383         return newIpv4Prefix(addressStringV4(addr), mask);
 384     }
 385
 386     public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr) {
 387         requireNonNull(addr, "Address must not be null");
 388         return prefix4Factory.newInstance(stripZone(ipv4AddressString(addr)) + "/32");
 389     }
 390
 391     public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr, final int mask) {
 392         requireNonNull(addr, "Address must not be null");
 393         return newIpv4Prefix(stripZone(ipv4AddressString(addr)), mask);
 394     }
 395
 396     public final @NonNull P4 ipv4PrefixForNoZone(final @NonNull A4NZ addr) {
 397         requireNonNull(addr, "Address must not be null");
 398         return prefix4Factory.newInstance(ipv4AddressString(addr) + "/32");
 399     }
 400
 401     public final @NonNull P4 ipv4PrefixForNoZone(final @NonNull A4NZ addr, final int mask) {
 402         requireNonNull(addr, "Address must not be null");
 403         return newIpv4Prefix(ipv4AddressString(addr), mask);
 404     }
 405
 406     public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] address, final int mask) {
 407         if (mask == 0) {
 408             // Easy case, reuse the template
 409             return prefix4Factory.getTemplate();
 410         }
 411
 412         return v4PrefixForShort(address, 0, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
 413     }
 414
 415     public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
 416         if (mask == 0) {
 417             // Easy case, reuse the template
 418             return prefix4Factory.getTemplate();
 419         }
 420
 421         return v4PrefixForShort(array, startOffset, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
 422     }
 423
 424     private static String stripZone(final String str) {
 425         final int percent = str.indexOf('%');
 426         return percent == -1 ? str : str.substring(0, percent);
 427     }
 428
 429     private @NonNull P4 newIpv4Prefix(final String addr, final int mask) {
 430         checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
 431         return prefix4Factory.newInstance(addr + '/' + mask);
 432     }
 433
 434     public final @NonNull Entry<A4, Integer> splitIpv4Prefix(final @NonNull P4 prefix) {
 435         return splitPrefix(address4Factory, ipv4PrefixString(prefix));
 436     }
 437
 438     public final @NonNull Entry<A4NZ, Integer> splitIpv4PrefixNoZone(final @NonNull P4 prefix) {
 439         return splitPrefix(address4NoZoneFactory, ipv4PrefixString(prefix));
 440     }
 441
 442     public final byte @NonNull[] ipv4PrefixToBytes(final @NonNull P4 prefix) {
 443         final String str = ipv4PrefixString(prefix);
 444         final int slash = str.lastIndexOf('/');
 445
 446         final byte[] bytes = new byte[INET4_LENGTH + 1];
 447         Ipv4Utils.fillIpv4Bytes(bytes, 0, str, 0, slash);
 448         bytes[INET4_LENGTH] = (byte)Integer.parseInt(str.substring(slash + 1), 10);
 449         return bytes;
 450     }
 451
 452     /**
 453      * Create an Ipv6Address by interpreting input bytes as an IPv6 address.
 454      *
 455      * @param bytes 16-byte array
 456      * @return An Ipv6Address object
 457      * @throws IllegalArgumentException if bytes has length different from 16
 458      * @throws NullPointerException if bytes is null
 459      */
 460     public final @NonNull A6 ipv6AddressFor(final byte @NonNull[] bytes) {
 461         return address6Factory.newInstance(addressStringV6(bytes));
 462     }
 463
 464     /**
 465      * Create an Ipv6Address by interpreting an {@link Inet6Address}.
 466      *
 467      * @param addr An {@link Inet6Address}
 468      * @return An Ipv6Address object
 469      * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
 470      * @throws NullPointerException if addr is null
 471      */
 472     public final @NonNull A6 ipv6AddressFor(final @NonNull InetAddress addr) {
 473         return address6Factory.newInstance(addressStringV6(addr));
 474     }
 475
 476     /**
 477      * Create an Ipv6AddressNoZone by interpreting input bytes as an IPv6 address.
 478      *
 479      * @param bytes 16-byte array
 480      * @return An Ipv6Address object
 481      * @throws IllegalArgumentException if bytes has length different from 16
 482      * @throws NullPointerException if bytes is null
 483      */
 484     public final @NonNull A6NZ ipv6AddressNoZoneFor(final byte @NonNull[] bytes) {
 485         return address6NoZoneFactory.newInstance(addressStringV6(bytes));
 486     }
 487
 488     /**
 489      * Create an Ipv6AddressNoZone by interpreting an {@link Inet6Address}.
 490      *
 491      * @param addr An {@link Inet6Address}
 492      * @return An Ipv6AddressNoZone object
 493      * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
 494      * @throws NullPointerException if addr is null
 495      */
 496     public final @NonNull A6NZ ipv6AddressNoZoneFor(final @NonNull InetAddress addr) {
 497         return address6NoZoneFactory.newInstance(addressStringV6(addr));
 498     }
 499
 500     public final @NonNull A6 ipv6AddressFrom(final @NonNull P6 prefix) {
 501         return prefixToAddress(address6Factory, ipv6PrefixString(prefix));
 502     }
 503
 504     public final @NonNull A6NZ ipv6AddressNoZoneFrom(final @NonNull P6 prefix) {
 505         return prefixToAddress(address6NoZoneFactory, ipv6PrefixString(prefix));
 506     }
 507
 508     public final byte @NonNull[] ipv6AddressBytes(final @NonNull A6 addr) {
 509         final String str = ipv6AddressString(addr);
 510         final int percent = str.indexOf('%');
 511         return ipv6StringBytes(str, percent == -1 ? str.length() : percent);
 512     }
 513
 514     public final byte @NonNull[] ipv6AddressNoZoneBytes(final @NonNull A6NZ addr) {
 515         final String str = ipv6AddressString(addr);
 516         return ipv6StringBytes(str, str.length());
 517     }
 518
 519     private static byte @NonNull[] ipv6StringBytes(final @NonNull String str, final int limit) {
 520         final byte[] bytes = new byte[INET6_LENGTH];
 521         Ipv6Utils.fillIpv6Bytes(bytes, str, limit);
 522         return bytes;
 523     }
 524
 525     /**
 526      * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
 527      *
 528      * @param bytes four-byte array
 529      * @return An Ipv6Prefix object
 530      * @throws IllegalArgumentException if bytes has length different from 16
 531      * @throws NullPointerException if bytes is null
 532      */
 533     public final @NonNull P6 ipv6PrefixFor(final byte @NonNull[] bytes) {
 534         return prefix6Factory.newInstance(addressStringV6(bytes) + "/128");
 535     }
 536
 537     /**
 538      * Create a Ipv6Prefix by combining the address with a mask. The address
 539      * bytes are interpreted as an address and the specified mask is concatenated to
 540      * it. The address bytes are not masked.
 541      *
 542      * @param address Input address as a 16-byte array
 543      * @param mask Prefix mask
 544      * @return An Ipv6Prefix object
 545      * @throws IllegalArgumentException if bytes has length different from 16 or if mask is not in range 0-128
 546      * @throws NullPointerException if bytes is null
 547      */
 548     public final @NonNull P6 ipv6PrefixFor(final byte @NonNull[] address, final int mask) {
 549         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 550         return prefix6Factory.newInstance(addressStringV6(address) + '/' + mask);
 551     }
 552
 553     /**
 554      * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
 555      *
 556      * @param addr an {@link Inet6Address}
 557      * @return An Ipv6Prefix object
 558      * @throws IllegalArgumentException if addr is not an Inet6Address
 559      * @throws NullPointerException if addr is null
 560      */
 561     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr) {
 562         return prefix6Factory.newInstance(addressStringV6(addr) + "/128");
 563     }
 564
 565     /**
 566      * Create a Ipv6Prefix by combining the address with a mask. The address
 567      * bytes are interpreted as an address and the specified mask is concatenated to
 568      * it. The address bytes are not masked.
 569      *
 570      * @param addr Input address
 571      * @param mask Prefix mask
 572      * @return An Ipv6Prefix object
 573      * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
 574      * @throws NullPointerException if addr is null
 575      */
 576     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr, final int mask) {
 577         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 578         return prefix6Factory.newInstance(addressStringV6(addr) + '/' + mask);
 579     }
 580
 581     public final @NonNull P6 ipv6PrefixFor(final @NonNull A6 addr) {
 582         requireNonNull(addr, "Address must not be null");
 583         return prefix6Factory.newInstance(stripZone(ipv6AddressString(addr)) + "/128");
 584     }
 585
 586     public final @NonNull P6 ipv6PrefixFor(final @NonNull A6 addr, final int mask) {
 587         requireNonNull(addr, "Address must not be null");
 588         return newIpv6Prefix(stripZone(ipv6AddressString(addr)), mask);
 589     }
 590
 591     public final @NonNull P6 ipv6PrefixForNoZone(final @NonNull A6NZ addr) {
 592         requireNonNull(addr, "Address must not be null");
 593         return prefix6Factory.newInstance(ipv6AddressString(addr) + "/128");
 594     }
 595
 596     public final @NonNull P6 ipv6PrefixForNoZone(final @NonNull A6NZ addr, final int mask) {
 597         requireNonNull(addr, "Address must not be null");
 598         return newIpv6Prefix(ipv6AddressString(addr), mask);
 599     }
 600
 601     public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] address, final int mask) {
 602         return ipv6PrefixForShort(address, 0, mask);
 603     }
 604
 605     public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
 606         if (mask == 0) {
 607             // Easy case, reuse the template
 608             return prefix6Factory.getTemplate();
 609         }
 610
 611         checkArgument(mask > 0 && mask <= 128, "Invalid mask %s", mask);
 612         final int size = mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1);
 613
 614         // Until we can instantiate an IPv6 address for a partial array, use a temporary buffer
 615         byte[] tmp = new byte[INET6_LENGTH];
 616         System.arraycopy(array, startOffset, tmp, 0, size);
 617         return ipv6PrefixFor(tmp, mask);
 618     }
 619
 620     private P6 newIpv6Prefix(final String addr, final int mask) {
 621         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 622         return prefix6Factory.newInstance(addr + '/' + mask);
 623     }
 624
 625     public final @NonNull Entry<A6, Integer> splitIpv6Prefix(final @NonNull P6 prefix) {
 626         return splitPrefix(address6Factory, ipv6PrefixString(prefix));
 627     }
 628
 629     public final @NonNull Entry<A6NZ, Integer> splitIpv6PrefixNoZone(final @NonNull P6 prefix) {
 630         return splitPrefix(address6NoZoneFactory, ipv6PrefixString(prefix));
 631     }
 632
 633     private static <T> @NonNull T prefixToAddress(final StringValueObjectFactory<T> factory, final String str) {
 634         return factory.newInstance(str.substring(0, str.lastIndexOf('/')));
 635     }
 636
 637     private static <T> @NonNull Entry<T, Integer> splitPrefix(final StringValueObjectFactory<T> factory,
 638             final String str) {
 639         final int slash = str.lastIndexOf('/');
 640         return new SimpleImmutableEntry<>(factory.newInstance(str.substring(0, slash)),
 641                 Integer.valueOf(str.substring(slash + 1)));
 642     }
 643
 644     public final byte @NonNull[] ipv6PrefixToBytes(final @NonNull P6 prefix) {
 645         final String str = ipv6PrefixString(prefix);
 646         final byte[] bytes = new byte[INET6_LENGTH + 1];
 647         final int slash = str.lastIndexOf('/');
 648         Ipv6Utils.fillIpv6Bytes(bytes, str, slash);
 649         bytes[INET6_LENGTH] = (byte)Integer.parseInt(str.substring(slash + 1), 10);
 650         return bytes;
 651     }
 652
 653     private static void appendIpv4String(final StringBuilder sb, final byte @NonNull[] bytes) {
 654         checkArgument(bytes.length == INET4_LENGTH, "IPv4 address length is 4 bytes");
 655
 656         sb.append(Byte.toUnsignedInt(bytes[0]));
 657         for (int i = 1; i < INET4_LENGTH; ++i) {
 658             sb.append('.').append(Byte.toUnsignedInt(bytes[i]));
 659         }
 660     }
 661
 662     static String addressStringV4(final byte @NonNull[] bytes) {
 663         final StringBuilder sb = new StringBuilder(15);
 664         appendIpv4String(sb, bytes);
 665         return sb.toString();
 666     }
 667
 668     private static @NonNull String addressStringV4(final InetAddress addr) {
 669         requireNonNull(addr, "Address must not be null");
 670         checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
 671         return addr.getHostAddress();
 672     }
 673
 674     private static String addressStringV6(final byte @NonNull[] bytes) {
 675         checkArgument(bytes.length == INET6_LENGTH, "IPv6 address length is 16 bytes");
 676
 677         try {
 678             return addressStringV6(Inet6Address.getByAddress(null, bytes, null));
 679         } catch (UnknownHostException e) {
 680             throw new IllegalArgumentException(String.format("Invalid input %s", bytes), e);
 681         }
 682     }
 683
 684     private static String addressStringV6(final InetAddress addr) {
 685         requireNonNull(addr, "Address must not be null");
 686         checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
 687         return addressStringV6((Inet6Address) addr);
 688     }
 689
 690     private static String addressStringV6(final Inet6Address addr) {
 691         return InetAddresses.toAddrString(addr);
 692     }
 693
 694     private static String prefixStringV4(final byte @NonNull[] bytes) {
 695         final StringBuilder sb = new StringBuilder(18);
 696         appendIpv4String(sb, bytes);
 697         return sb.append("/32").toString();
 698     }
 699
 700     private static String prefixStringV4(final byte @NonNull[] bytes, final int mask) {
 701         checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
 702
 703         final StringBuilder sb = new StringBuilder(18);
 704         appendIpv4String(sb, bytes);
 705         return sb.append('/').append(mask).toString();
 706     }
 707
 708     private P4 v4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int size, final int mask) {
 709         if (startOffset == 0 && size == INET4_LENGTH && array.length == INET4_LENGTH) {
 710             // Easy case, fall back to non-short
 711             return ipv4PrefixFor(array, mask);
 712         }
 713
 714         final StringBuilder sb = new StringBuilder(18);
 715
 716         // Add from address
 717         sb.append(Byte.toUnsignedInt(array[startOffset]));
 718         for (int i = 1; i < size; i++) {
 719             sb.append('.').append(Byte.toUnsignedInt(array[startOffset + i]));
 720         }
 721
 722         // Add zeros
 723         for (int i = size; i < INET4_LENGTH; i++) {
 724             sb.append(".0");
 725         }
 726
 727         // Add mask
 728         checkArgument(mask > 0 && mask <= 32, "Invalid mask %s", mask);
 729         sb.append('/').append(mask);
 730
 731         return prefix4Factory.newInstance(sb.toString());
 732     }
 733 }