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