2 * Copyright (c) 2016 Pantheon Technologies s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.model.ietf.util;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
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;
26 * A set of utility methods to efficiently instantiate various ietf-inet-types DTOs.
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;
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;
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");
52 protected abstract @NonNull A ipv4Address(@NonNull A4 addr);
54 protected abstract @NonNull ANZ ipv4AddressNoZone(@NonNull A4NZ addr);
56 protected abstract @NonNull A ipv6Address(@NonNull A6 addr);
58 protected abstract @NonNull ANZ ipv6AddressNoZone(@NonNull A6NZ addr);
60 protected abstract @Nullable A4 maybeIpv4Address(@NonNull A addr);
62 protected abstract @Nullable A4NZ maybeIpv4AddressNoZone(@NonNull ANZ addr);
64 protected abstract @Nullable A6 maybeIpv6Address(@NonNull A addr);
66 protected abstract @Nullable A6NZ maybeIpv6AddressNoZone(@NonNull ANZ addr);
68 protected abstract @NonNull P ipv4Prefix(@NonNull P4 addr);
70 protected abstract @NonNull P ipv6Prefix(@NonNull P6 addr);
72 protected abstract @NonNull String ipv4AddressString(@NonNull A4 addr);
74 protected abstract @NonNull String ipv6AddressString(@NonNull A6 addr);
76 protected abstract @NonNull String ipv4PrefixString(@NonNull P4 prefix);
78 protected abstract @NonNull String ipv6PrefixString(@NonNull P6 prefix);
81 * Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.
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
88 public final @NonNull A ipAddressFor(final byte @NonNull[] bytes) {
89 switch (bytes.length) {
91 return ipv4Address(ipv4AddressFor(bytes));
93 return ipv6Address(ipv6AddressFor(bytes));
95 throw new IllegalArgumentException("Invalid array length " + bytes.length);
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));
106 throw new IllegalArgumentException("Unhandled address " + addr);
111 * Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.
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
118 public final @NonNull ANZ ipAddressNoZoneFor(final byte @NonNull[] bytes) {
119 switch (bytes.length) {
121 return ipv4AddressNoZone(ipv4AddressNoZoneFor(bytes));
123 return ipv6AddressNoZone(ipv6AddressNoZoneFor(bytes));
125 throw new IllegalArgumentException("Invalid array length " + bytes.length);
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));
136 throw new IllegalArgumentException("Unhandled address " + addr);
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.
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
152 public final @NonNull P ipPrefixFor(final byte @NonNull[] bytes, final int mask) {
153 switch (bytes.length) {
155 return ipv4Prefix(ipv4PrefixFor(bytes, mask));
157 return ipv6Prefix(ipv6PrefixFor(bytes, mask));
159 throw new IllegalArgumentException("Invalid array length " + bytes.length);
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));
170 throw new IllegalArgumentException("Unhandled address " + addr);
174 public final @NonNull InetAddress inetAddressFor(final @NonNull A addr) {
175 final A4 v4 = maybeIpv4Address(addr);
177 return inet4AddressFor(v4);
179 final A6 v6 = maybeIpv6Address(addr);
180 checkArgument(v6 != null, "Address %s is neither IPv4 nor IPv6", addr);
181 return inet6AddressFor(v6);
184 public final @NonNull InetAddress inetAddressForNoZone(final @NonNull ANZ addr) {
185 final A4NZ v4 = maybeIpv4AddressNoZone(addr);
187 return inet4AddressForNoZone(v4);
189 final A6NZ v6 = maybeIpv6AddressNoZone(addr);
190 checkArgument(v6 != null, "Address %s is neither IPv4 nor IPv6", addr);
191 return inet6AddressForNoZone(v6);
195 public final @NonNull Inet4Address inet4AddressFor(final @NonNull A4 addr) {
197 return (Inet4Address) InetAddress.getByAddress(ipv4AddressBytes(addr));
198 } catch (UnknownHostException e) {
199 throw new IllegalArgumentException("Invalid address " + addr, e);
203 public final @NonNull Inet4Address inet4AddressForNoZone(final @NonNull A4NZ addr) {
205 return (Inet4Address) InetAddress.getByAddress(ipv4AddressNoZoneBytes(addr));
206 } catch (UnknownHostException e) {
207 throw new IllegalArgumentException("Invalid address " + addr, e);
211 public final @NonNull Inet6Address inet6AddressFor(final @NonNull A6 addr) {
213 return (Inet6Address) InetAddress.getByAddress(ipv6AddressBytes(addr));
214 } catch (UnknownHostException e) {
215 throw new IllegalArgumentException("Invalid address " + addr, e);
219 public final @NonNull Inet6Address inet6AddressForNoZone(final @NonNull A6NZ addr) {
221 return (Inet6Address) InetAddress.getByAddress(ipv6AddressNoZoneBytes(addr));
222 } catch (UnknownHostException e) {
223 throw new IllegalArgumentException("Invalid address " + addr, e);
228 * Create an Ipv4Address by interpreting input bytes as an IPv4 address.
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
235 public final @NonNull A4 ipv4AddressFor(final byte @NonNull[] bytes) {
236 return address4Factory.newInstance(addressStringV4(bytes));
240 * Create an Ipv4Address by interpreting an {@link Inet4Address}.
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
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());
254 * Create an Ipv4AddressNoZone by interpreting input bytes as an IPv4 address.
256 * @param bytes 4-byte array
257 * @return An Ipv4AddressNoZone object
258 * @throws IllegalArgumentException if bytes has length different from 4
259 * @throws NullPointerException if bytes is null
261 public final @NonNull A4NZ ipv4AddressNoZoneFor(final byte @NonNull[] bytes) {
262 return address4NoZoneFactory.newInstance(addressStringV4(bytes));
266 * Create an Ipv4AddressNoZone by interpreting an {@link Inet4Address}.
268 * @param addr An {@link Inet4Address}
269 * @return An Ipv4AddressNoZone object
270 * @throws IllegalArgumentException if addr is not an {@link Inet4Address}
271 * @throws NullPointerException if addr is null
273 public final @NonNull A4NZ ipv4AddressNoZoneFor(final @NonNull InetAddress addr) {
274 requireNonNull(addr, "Address must not be null");
275 checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
276 return address4NoZoneFactory.newInstance(addr.getHostAddress());
279 public final @NonNull A4 ipv4AddressFrom(final @NonNull P4 prefix) {
280 return prefixToAddress(address4Factory, ipv4PrefixString(prefix));
283 public final @NonNull A4NZ ipv4AddressNoZoneFrom(final @NonNull P4 prefix) {
284 return prefixToAddress(address4NoZoneFactory, ipv4PrefixString(prefix));
287 public final byte @NonNull[] ipv4AddressBytes(final @NonNull A4 addr) {
289 * This implementation relies heavily on the input string having been validated to comply with
290 * the Ipv4Address pattern, which may include a zone index.
292 final String str = ipv4AddressString(addr);
293 final int percent = str.indexOf('%');
294 return ipv4StringBytes(str, percent == -1 ? str.length() : percent);
297 public final byte @NonNull[] ipv4AddressNoZoneBytes(final @NonNull A4NZ addr) {
299 * This implementation relies heavily on the input string having been validated to comply with
300 * the Ipv4AddressNoZone pattern, which must not include a zone index.
302 final String str = ipv4AddressString(addr);
303 return ipv4StringBytes(str, str.length());
306 private static byte @NonNull[] ipv4StringBytes(final String str, final int limit) {
307 final byte[] bytes = new byte[INET4_LENGTH];
308 Ipv4Utils.fillIpv4Bytes(bytes, 0, str, 0, limit);
313 * Create a /32 Ipv4Prefix by interpreting input bytes as an IPv4 address.
315 * @param bytes four-byte array
316 * @return An Ipv4Prefix object
317 * @throws IllegalArgumentException if bytes has length different from 4
318 * @throws NullPointerException if bytes is null
320 public final @NonNull P4 ipv4PrefixFor(final byte @NonNull[] bytes) {
321 return prefix4Factory.newInstance(prefixStringV4(bytes));
325 * Create a Ipv4Prefix by combining the address with a mask. The address
326 * bytes are interpreted as an address and the specified mask is concatenated to
327 * it. The address bytes are not masked, hence input <code>address = { 1, 2, 3, 4 }</code>
328 * and <code>mask=24</code> will result in <code>1.2.3.4/24</code>.
330 * @param address Input address as a 4-byte array
331 * @param mask Prefix mask
332 * @return An Ipv4Prefix object
333 * @throws IllegalArgumentException if bytes has length different from 4 or if mask is not in range 0-32
334 * @throws NullPointerException if bytes is null
336 public final @NonNull P4 ipv4PrefixFor(final byte @NonNull[] address, final int mask) {
337 return prefix4Factory.newInstance(prefixStringV4(address, mask));
341 * Create a /32 Ipv4Prefix for an {@link Inet4Address}.
343 * @param addr An {@link Inet4Address}
344 * @return An Ipv4Prefix object
345 * @throws IllegalArgumentException if addr is not an Inet4Address
346 * @throws NullPointerException if addr is null
348 public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr) {
349 requireNonNull(addr, "Address must not be null");
350 checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
351 return prefix4Factory.newInstance(addr.getHostAddress() + "/32");
355 * Create a Ipv4Prefix by combining the address with a mask. The address bytes are not masked.
357 * @param addr An {@link Inet4Address}
358 * @param mask Prefix mask
359 * @return An Ipv4Prefix object
360 * @throws IllegalArgumentException if addr is not an Inet4Address or if mask is not in range 0-32
361 * @throws NullPointerException if addr is null
363 public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr, final int mask) {
364 requireNonNull(addr, "Address must not be null");
365 checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
366 return newIpv4Prefix(addr.getHostAddress(), mask);
369 public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr) {
370 requireNonNull(addr, "Address must not be null");
371 return prefix4Factory.newInstance(stripZone(ipv4AddressString(addr)) + "/32");
374 public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr, final int mask) {
375 requireNonNull(addr, "Address must not be null");
376 return newIpv4Prefix(stripZone(ipv4AddressString(addr)), mask);
379 public final @NonNull P4 ipv4PrefixForNoZone(final @NonNull A4NZ addr) {
380 requireNonNull(addr, "Address must not be null");
381 return prefix4Factory.newInstance(ipv4AddressString(addr) + "/32");
384 public final @NonNull P4 ipv4PrefixForNoZone(final @NonNull A4NZ addr, final int mask) {
385 requireNonNull(addr, "Address must not be null");
386 return newIpv4Prefix(ipv4AddressString(addr), mask);
389 public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] address, final int mask) {
391 // Easy case, reuse the template
392 return prefix4Factory.getTemplate();
395 return v4PrefixForShort(address, 0, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
398 public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
400 // Easy case, reuse the template
401 return prefix4Factory.getTemplate();
404 return v4PrefixForShort(array, startOffset, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
407 private static String stripZone(final String str) {
408 final int percent = str.indexOf('%');
409 return percent == -1 ? str : str.substring(0, percent);
412 private @NonNull P4 newIpv4Prefix(final String addr, final int mask) {
413 checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
414 return prefix4Factory.newInstance(addr + '/' + mask);
417 public final @NonNull Entry<A4, Integer> splitIpv4Prefix(final @NonNull P4 prefix) {
418 return splitPrefix(address4Factory, ipv4PrefixString(prefix));
421 public final @NonNull Entry<A4NZ, Integer> splitIpv4PrefixNoZone(final @NonNull P4 prefix) {
422 return splitPrefix(address4NoZoneFactory, ipv4PrefixString(prefix));
425 public final byte @NonNull[] ipv4PrefixToBytes(final @NonNull P4 prefix) {
426 final String str = ipv4PrefixString(prefix);
427 final int slash = str.lastIndexOf('/');
429 final byte[] bytes = new byte[INET4_LENGTH + 1];
430 Ipv4Utils.fillIpv4Bytes(bytes, 0, str, 0, slash);
431 bytes[INET4_LENGTH] = (byte)Integer.parseInt(str.substring(slash + 1), 10);
436 * Create an Ipv6Address by interpreting input bytes as an IPv6 address.
438 * @param bytes 16-byte array
439 * @return An Ipv6Address object
440 * @throws IllegalArgumentException if bytes has length different from 16
441 * @throws NullPointerException if bytes is null
443 public final @NonNull A6 ipv6AddressFor(final byte @NonNull[] bytes) {
444 return address6Factory.newInstance(addressStringV6(bytes));
448 * Create an Ipv6Address by interpreting an {@link Inet6Address}.
450 * @param addr An {@link Inet6Address}
451 * @return An Ipv6Address object
452 * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
453 * @throws NullPointerException if addr is null
455 public final @NonNull A6 ipv6AddressFor(final @NonNull InetAddress addr) {
456 requireNonNull(addr, "Address must not be null");
457 checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
458 return address6Factory.newInstance(addressStringV6(addr));
462 * Create an Ipv6AddressNoZone by interpreting input bytes as an IPv6 address.
464 * @param bytes 16-byte array
465 * @return An Ipv6Address object
466 * @throws IllegalArgumentException if bytes has length different from 16
467 * @throws NullPointerException if bytes is null
469 public final @NonNull A6NZ ipv6AddressNoZoneFor(final byte @NonNull[] bytes) {
470 return address6NoZoneFactory.newInstance(addressStringV6(bytes));
474 * Create an Ipv6AddressNoZone by interpreting an {@link Inet6Address}.
476 * @param addr An {@link Inet6Address}
477 * @return An Ipv6AddressNoZone object
478 * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
479 * @throws NullPointerException if addr is null
481 public final @NonNull A6NZ ipv6AddressNoZoneFor(final @NonNull InetAddress addr) {
482 requireNonNull(addr, "Address must not be null");
483 checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
484 return address6NoZoneFactory.newInstance(addressStringV6(addr));
487 public final @NonNull A6 ipv6AddressFrom(final @NonNull P6 prefix) {
488 return prefixToAddress(address6Factory, ipv6PrefixString(prefix));
491 public final @NonNull A6NZ ipv6AddressNoZoneFrom(final @NonNull P6 prefix) {
492 return prefixToAddress(address6NoZoneFactory, ipv6PrefixString(prefix));
495 public final byte @NonNull[] ipv6AddressBytes(final @NonNull A6 addr) {
496 final String str = ipv6AddressString(addr);
497 final int percent = str.indexOf('%');
498 return ipv6StringBytes(str, percent == -1 ? str.length() : percent);
501 public final byte @NonNull[] ipv6AddressNoZoneBytes(final @NonNull A6NZ addr) {
502 final String str = ipv6AddressString(addr);
503 return ipv6StringBytes(str, str.length());
506 private static byte @NonNull[] ipv6StringBytes(final @NonNull String str, final int limit) {
507 final byte[] bytes = new byte[INET6_LENGTH];
508 Ipv6Utils.fillIpv6Bytes(bytes, str, limit);
513 * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
515 * @param bytes four-byte array
516 * @return An Ipv6Prefix object
517 * @throws IllegalArgumentException if bytes has length different from 16
518 * @throws NullPointerException if bytes is null
520 public final @NonNull P6 ipv6PrefixFor(final byte @NonNull[] bytes) {
521 return prefix6Factory.newInstance(addressStringV6(bytes) + "/128");
525 * Create a Ipv6Prefix by combining the address with a mask. The address
526 * bytes are interpreted as an address and the specified mask is concatenated to
527 * it. The address bytes are not masked.
529 * @param address Input address as a 16-byte array
530 * @param mask Prefix mask
531 * @return An Ipv6Prefix object
532 * @throws IllegalArgumentException if bytes has length different from 16 or if mask is not in range 0-128
533 * @throws NullPointerException if bytes is null
535 public final @NonNull P6 ipv6PrefixFor(final byte @NonNull[] address, final int mask) {
536 checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
537 return prefix6Factory.newInstance(addressStringV6(address) + '/' + mask);
541 * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv4 address.
543 * @param addr an {@link Inet6Address}
544 * @return An Ipv6Prefix object
545 * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
546 * @throws NullPointerException if addr is null
548 public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr) {
549 return prefix6Factory.newInstance(addressStringV6(addr) + "/128");
553 * Create a Ipv6Prefix by combining the address with a mask. The address
554 * bytes are interpreted as an address and the specified mask is concatenated to
555 * it. The address bytes are not masked.
557 * @param addr Input address
558 * @param mask Prefix mask
559 * @return An Ipv6Prefix object
560 * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
561 * @throws NullPointerException if addr is null
563 public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr, final int mask) {
564 requireNonNull(addr, "Address must not be null");
565 checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
566 checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
567 return prefix6Factory.newInstance(addressStringV6(addr) + '/' + mask);
570 public final @NonNull P6 ipv6PrefixFor(final @NonNull A6 addr) {
571 requireNonNull(addr, "Address must not be null");
572 return prefix6Factory.newInstance(stripZone(ipv6AddressString(addr)) + "/128");
575 public final @NonNull P6 ipv6PrefixFor(final @NonNull A6 addr, final int mask) {
576 requireNonNull(addr, "Address must not be null");
577 return newIpv6Prefix(stripZone(ipv6AddressString(addr)), mask);
580 public final @NonNull P6 ipv6PrefixForNoZone(final @NonNull A6NZ addr) {
581 requireNonNull(addr, "Address must not be null");
582 return prefix6Factory.newInstance(ipv6AddressString(addr) + "/128");
585 public final @NonNull P6 ipv6PrefixForNoZone(final @NonNull A6NZ addr, final int mask) {
586 requireNonNull(addr, "Address must not be null");
587 return newIpv6Prefix(ipv6AddressString(addr), mask);
590 public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] address, final int mask) {
591 return ipv6PrefixForShort(address, 0, mask);
594 public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
596 // Easy case, reuse the template
597 return prefix6Factory.getTemplate();
600 checkArgument(mask > 0 && mask <= 128, "Invalid mask %s", mask);
601 final int size = mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1);
603 // Until we can instantiate an IPv6 address for a partial array, use a temporary buffer
604 byte[] tmp = new byte[INET6_LENGTH];
605 System.arraycopy(array, startOffset, tmp, 0, size);
606 return ipv6PrefixFor(tmp, mask);
609 private P6 newIpv6Prefix(final String addr, final int mask) {
610 checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
611 return prefix6Factory.newInstance(addr + '/' + mask);
614 public final @NonNull Entry<A6, Integer> splitIpv6Prefix(final @NonNull P6 prefix) {
615 return splitPrefix(address6Factory, ipv6PrefixString(prefix));
618 public final @NonNull Entry<A6NZ, Integer> splitIpv6PrefixNoZone(final @NonNull P6 prefix) {
619 return splitPrefix(address6NoZoneFactory, ipv6PrefixString(prefix));
622 private static <T> @NonNull T prefixToAddress(final StringValueObjectFactory<T> factory, final String str) {
623 return factory.newInstance(str.substring(0, str.lastIndexOf('/')));
626 private static <T> @NonNull Entry<T, Integer> splitPrefix(final StringValueObjectFactory<T> factory,
628 final int slash = str.lastIndexOf('/');
629 return new SimpleImmutableEntry<>(factory.newInstance(str.substring(0, slash)),
630 Integer.valueOf(str.substring(slash + 1)));
633 public final byte @NonNull[] ipv6PrefixToBytes(final @NonNull P6 prefix) {
634 final String str = ipv6PrefixString(prefix);
635 final byte[] bytes = new byte[INET6_LENGTH + 1];
636 final int slash = str.lastIndexOf('/');
637 Ipv6Utils.fillIpv6Bytes(bytes, str, slash);
638 bytes[INET6_LENGTH] = (byte)Integer.parseInt(str.substring(slash + 1), 10);
642 private static void appendIpv4String(final StringBuilder sb, final byte @NonNull[] bytes) {
643 checkArgument(bytes.length == INET4_LENGTH, "IPv4 address length is 4 bytes");
645 sb.append(Byte.toUnsignedInt(bytes[0]));
646 for (int i = 1; i < INET4_LENGTH; ++i) {
647 sb.append('.').append(Byte.toUnsignedInt(bytes[i]));
651 static String addressStringV4(final byte @NonNull[] bytes) {
652 final StringBuilder sb = new StringBuilder(15);
653 appendIpv4String(sb, bytes);
654 return sb.toString();
657 private static String addressStringV6(final byte @NonNull[] bytes) {
658 checkArgument(bytes.length == INET6_LENGTH, "IPv6 address length is 16 bytes");
661 return addressStringV6(Inet6Address.getByAddress(bytes));
662 } catch (UnknownHostException e) {
663 throw new IllegalArgumentException(String.format("Invalid input %s", bytes), e);
667 private static String addressStringV6(final InetAddress addr) {
668 return InetAddresses.toAddrString(addr);
671 private static String prefixStringV4(final byte @NonNull[] bytes) {
672 final StringBuilder sb = new StringBuilder(18);
673 appendIpv4String(sb, bytes);
674 return sb.append("/32").toString();
677 private static String prefixStringV4(final byte @NonNull[] bytes, final int mask) {
678 checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
680 final StringBuilder sb = new StringBuilder(18);
681 appendIpv4String(sb, bytes);
682 return sb.append('/').append(mask).toString();
685 private P4 v4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int size, final int mask) {
686 if (startOffset == 0 && size == INET4_LENGTH && array.length == INET4_LENGTH) {
687 // Easy case, fall back to non-short
688 return ipv4PrefixFor(array, mask);
691 final StringBuilder sb = new StringBuilder(18);
694 sb.append(Byte.toUnsignedInt(array[startOffset]));
695 for (int i = 1; i < size; i++) {
696 sb.append('.').append(Byte.toUnsignedInt(array[startOffset + i]));
700 for (int i = size; i < INET4_LENGTH; i++) {
705 checkArgument(mask > 0 && mask <= 32, "Invalid mask %s", mask);
706 sb.append('/').append(mask);
708 return prefix4Factory.newInstance(sb.toString());