Remove deprecated ietf-type-util methods
[mdsal.git] / model / ietf / ietf-type-util / src / main / java / org / opendaylight / mdsal / model / ietf / util / AbstractIetfInetUtil.java
index 85dc1c632364c1c8d8c8d0b44dcc4a0f967b0074..9a92be06772a3701f453e70ae35d0bd89134909c 100644 (file)
@@ -31,29 +31,28 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
     private static final int INET4_LENGTH = 4;
     private static final int INET6_LENGTH = 16;
 
-    private final StringValueObjectFactory<A4> address4Factory;
     private final StringValueObjectFactory<A4NZ> address4NoZoneFactory;
     private final StringValueObjectFactory<P4> prefix4Factory;
-    private final StringValueObjectFactory<A6> address6Factory;
     private final StringValueObjectFactory<A6NZ> address6NoZoneFactory;
     private final StringValueObjectFactory<P6> prefix6Factory;
+    private final Class<A4NZ> addr4nzClass;
+    private final Class<A6NZ> addr6nzClass;
 
-    protected AbstractIetfInetUtil(final Class<A4> addr4Class, final Class<A4NZ> addr4nzClass,
-            final Class<P4> prefix4Class, final Class<A6> addr6Class, final Class<A6NZ> addr6nzClass,
-            final Class<P6> prefix6Class) {
-        this.address4Factory = StringValueObjectFactory.create(addr4Class, "0.0.0.0");
+    protected AbstractIetfInetUtil(final Class<A4NZ> addr4nzClass, final Class<P4> prefix4Class,
+            final Class<A6NZ> addr6nzClass, final Class<P6> prefix6Class) {
+        this.addr4nzClass = requireNonNull(addr4nzClass);
+        this.addr6nzClass = requireNonNull(addr6nzClass);
         this.address4NoZoneFactory = StringValueObjectFactory.create(addr4nzClass, "0.0.0.0");
         this.prefix4Factory = StringValueObjectFactory.create(prefix4Class, "0.0.0.0/0");
-        this.address6Factory = StringValueObjectFactory.create(addr6Class, "::0");
         this.address6NoZoneFactory = StringValueObjectFactory.create(addr6nzClass, "::0");
         this.prefix6Factory = StringValueObjectFactory.create(prefix6Class, "::0/0");
     }
 
-    protected abstract @NonNull A ipv4Address(@NonNull A4 addr);
+    protected abstract @NonNull A ipv4Address(@NonNull A4NZ addr);
 
     protected abstract @NonNull ANZ ipv4AddressNoZone(@NonNull A4NZ addr);
 
-    protected abstract @NonNull A ipv6Address(@NonNull A6 addr);
+    protected abstract @NonNull A ipv6Address(@NonNull A6NZ addr);
 
     protected abstract @NonNull ANZ ipv6AddressNoZone(@NonNull A6NZ addr);
 
@@ -118,9 +117,9 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
     public final @NonNull ANZ ipAddressNoZoneFor(final byte @NonNull[] bytes) {
         switch (bytes.length) {
             case INET4_LENGTH:
-                return ipv4AddressNoZone(ipv4AddressNoZoneFor(bytes));
+                return ipv4AddressNoZone(ipv4AddressFor(bytes));
             case INET6_LENGTH:
-                return ipv6AddressNoZone(ipv6AddressNoZoneFor(bytes));
+                return ipv6AddressNoZone(ipv6AddressFor(bytes));
             default:
                 throw new IllegalArgumentException("Invalid array length " + bytes.length);
         }
@@ -129,9 +128,9 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
     public final @NonNull ANZ ipAddressNoZoneFor(final @NonNull InetAddress addr) {
         requireNonNull(addr, "Address must not be null");
         if (addr instanceof Inet4Address) {
-            return ipv4AddressNoZone(ipv4AddressNoZoneFor(addr));
+            return ipv4AddressNoZone(ipv4AddressFor(addr));
         } else if (addr instanceof Inet6Address) {
-            return ipv6AddressNoZone(ipv6AddressNoZoneFor(addr));
+            return ipv6AddressNoZone(ipv6AddressFor(addr));
         } else {
             throw new IllegalArgumentException("Unhandled address " + addr);
         }
@@ -225,63 +224,59 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
     }
 
     /**
-     * Create an Ipv4Address by interpreting input bytes as an IPv4 address.
+     * Create an Ipv4AddressNoZone by interpreting input bytes as an IPv4 address.
      *
      * @param bytes 4-byte array
-     * @return An Ipv4Address object
+     * @return An Ipv4AddressNoZone object
      * @throws IllegalArgumentException if bytes has length different from 4
      * @throws NullPointerException if bytes is null
      */
-    public final @NonNull A4 ipv4AddressFor(final byte @NonNull[] bytes) {
-        return address4Factory.newInstance(addressStringV4(bytes));
+    public final @NonNull A4NZ ipv4AddressFor(final byte @NonNull[] bytes) {
+        return address4NoZoneFactory.newInstance(addressStringV4(bytes));
     }
 
     /**
-     * Create an Ipv4Address by interpreting an {@link Inet4Address}.
+     * Create an Ipv4AddressNoZone by interpreting an {@link Inet4Address}.
      *
      * @param addr An {@link Inet4Address}
-     * @return An Ipv4Address object
+     * @return An Ipv4AddressNoZone object
      * @throws IllegalArgumentException if addr is not an {@link Inet4Address}
      * @throws NullPointerException if addr is null
      */
-    public final @NonNull A4 ipv4AddressFor(final @NonNull InetAddress addr) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return address4Factory.newInstance(addr.getHostAddress());
+    public final @NonNull A4NZ ipv4AddressFor(final @NonNull InetAddress addr) {
+        return address4NoZoneFactory.newInstance(addressStringV4(addr));
     }
 
     /**
-     * Create an Ipv4AddressNoZone by interpreting input bytes as an IPv4 address.
+     * Create an Ipv4AddressNoZone by interpreting input 32 bits as an IPv4 address in big-endian format.
      *
-     * @param bytes 4-byte array
+     * @param bits 32 bits, big endian
      * @return An Ipv4AddressNoZone object
-     * @throws IllegalArgumentException if bytes has length different from 4
-     * @throws NullPointerException if bytes is null
      */
-    public final @NonNull A4NZ ipv4AddressNoZoneFor(final byte @NonNull[] bytes) {
-        return address4NoZoneFactory.newInstance(addressStringV4(bytes));
+    public final @NonNull A4NZ ipv4AddressFor(final int bits) {
+        return address4NoZoneFactory.newInstance(Ipv4Utils.addressString(bits));
     }
 
     /**
-     * Create an Ipv4AddressNoZone by interpreting an {@link Inet4Address}.
+     * Create an Ipv4AddressNoZone by interpreting an Ipv4Address.
      *
-     * @param addr An {@link Inet4Address}
+     * @param addr An Ipv4Address
      * @return An Ipv4AddressNoZone object
-     * @throws IllegalArgumentException if addr is not an {@link Inet4Address}
      * @throws NullPointerException if addr is null
      */
-    public final @NonNull A4NZ ipv4AddressNoZoneFor(final @NonNull InetAddress addr) {
+    public final @NonNull A4NZ ipv4AddressNoZoneFor(final @NonNull A4 addr) {
         requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return address4NoZoneFactory.newInstance(addr.getHostAddress());
+        return addr4nzClass.isInstance(addr) ? addr4nzClass.cast(addr)
+                : address4NoZoneFactory.newInstance(stripZone(ipv4AddressString(addr)));
     }
 
-    public final @NonNull A4 ipv4AddressFrom(final @NonNull P4 prefix) {
-        return prefixToAddress(address4Factory, ipv4PrefixString(prefix));
+    public final @NonNull A4NZ ipv4AddressFrom(final @NonNull P4 prefix) {
+        return prefixToAddress(address4NoZoneFactory, ipv4PrefixString(prefix));
     }
 
+    @Deprecated(forRemoval = true)
     public final @NonNull A4NZ ipv4AddressNoZoneFrom(final @NonNull P4 prefix) {
-        return prefixToAddress(address4NoZoneFactory, ipv4PrefixString(prefix));
+        return ipv4AddressFrom(prefix);
     }
 
     public final byte @NonNull[] ipv4AddressBytes(final @NonNull A4 addr) {
@@ -291,7 +286,13 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
          */
         final String str = ipv4AddressString(addr);
         final int percent = str.indexOf('%');
-        return ipv4StringBytes(str, percent == -1 ? str.length() : percent);
+        return Ipv4Utils.addressBytes(str, percent == -1 ? str.length() : percent);
+    }
+
+    public final int ipv4AddressBits(final @NonNull A4 addr) {
+        final String str = ipv4AddressString(addr);
+        final int percent = str.indexOf('%');
+        return Ipv4Utils.addressBits(str, percent == -1 ? str.length() : percent);
     }
 
     public final byte @NonNull[] ipv4AddressNoZoneBytes(final @NonNull A4NZ addr) {
@@ -300,13 +301,12 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
          * the Ipv4AddressNoZone pattern, which must not include a zone index.
          */
         final String str = ipv4AddressString(addr);
-        return ipv4StringBytes(str, str.length());
+        return Ipv4Utils.addressBytes(str, str.length());
     }
 
-    private static byte @NonNull[] ipv4StringBytes(final String str, final int limit) {
-        final byte[] bytes = new byte[INET4_LENGTH];
-        Ipv4Utils.fillIpv4Bytes(bytes, 0, str, 0, limit);
-        return bytes;
+    public final int ipv4AddressNoZoneBits(final @NonNull A4NZ addr) {
+        final String str = ipv4AddressString(addr);
+        return Ipv4Utils.addressBits(str, str.length());
     }
 
     /**
@@ -346,9 +346,7 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return prefix4Factory.newInstance(addr.getHostAddress() + "/32");
+        return prefix4Factory.newInstance(addressStringV4(addr) + "/32");
     }
 
     /**
@@ -361,9 +359,7 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr, final int mask) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return newIpv4Prefix(addr.getHostAddress(), mask);
+        return newIpv4Prefix(addressStringV4(addr), mask);
     }
 
     public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr) {
@@ -414,12 +410,13 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         return prefix4Factory.newInstance(addr + '/' + mask);
     }
 
-    public final @NonNull Entry<A4, Integer> splitIpv4Prefix(final @NonNull P4 prefix) {
-        return splitPrefix(address4Factory, ipv4PrefixString(prefix));
+    public final @NonNull Entry<A4NZ, Integer> splitIpv4Prefix(final @NonNull P4 prefix) {
+        return splitPrefix(address4NoZoneFactory, ipv4PrefixString(prefix));
     }
 
+    @Deprecated(forRemoval = true)
     public final @NonNull Entry<A4NZ, Integer> splitIpv4PrefixNoZone(final @NonNull P4 prefix) {
-        return splitPrefix(address4NoZoneFactory, ipv4PrefixString(prefix));
+        return splitIpv4Prefix(prefix);
     }
 
     public final byte @NonNull[] ipv4PrefixToBytes(final @NonNull P4 prefix) {
@@ -440,8 +437,8 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws IllegalArgumentException if bytes has length different from 16
      * @throws NullPointerException if bytes is null
      */
-    public final @NonNull A6 ipv6AddressFor(final byte @NonNull[] bytes) {
-        return address6Factory.newInstance(addressStringV6(bytes));
+    public final @NonNull A6NZ ipv6AddressFor(final byte @NonNull[] bytes) {
+        return address6NoZoneFactory.newInstance(addressStringV6(bytes));
     }
 
     /**
@@ -452,44 +449,30 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
      * @throws NullPointerException if addr is null
      */
-    public final @NonNull A6 ipv6AddressFor(final @NonNull InetAddress addr) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
-        return address6Factory.newInstance(addressStringV6(addr));
-    }
-
-    /**
-     * Create an Ipv6AddressNoZone by interpreting input bytes as an IPv6 address.
-     *
-     * @param bytes 16-byte array
-     * @return An Ipv6Address object
-     * @throws IllegalArgumentException if bytes has length different from 16
-     * @throws NullPointerException if bytes is null
-     */
-    public final @NonNull A6NZ ipv6AddressNoZoneFor(final byte @NonNull[] bytes) {
-        return address6NoZoneFactory.newInstance(addressStringV6(bytes));
+    public final @NonNull A6NZ ipv6AddressFor(final @NonNull InetAddress addr) {
+        return address6NoZoneFactory.newInstance(addressStringV6(addr));
     }
 
     /**
-     * Create an Ipv6AddressNoZone by interpreting an {@link Inet6Address}.
+     * Create an Ipv6AddressNoZone by interpreting an Ipv6Address.
      *
-     * @param addr An {@link Inet6Address}
+     * @param addr An Ipv6Address
      * @return An Ipv6AddressNoZone object
-     * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
      * @throws NullPointerException if addr is null
      */
-    public final @NonNull A6NZ ipv6AddressNoZoneFor(final @NonNull InetAddress addr) {
+    public final @NonNull A6NZ ipv6AddressNoZoneFor(final @NonNull A6 addr) {
         requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
-        return address6NoZoneFactory.newInstance(addressStringV6(addr));
+        return addr6nzClass.isInstance(addr) ? addr6nzClass.cast(addr)
+                : address6NoZoneFactory.newInstance(stripZone(ipv6AddressString(addr)));
     }
 
-    public final @NonNull A6 ipv6AddressFrom(final @NonNull P6 prefix) {
-        return prefixToAddress(address6Factory, ipv6PrefixString(prefix));
+    public final @NonNull A6NZ ipv6AddressFrom(final @NonNull P6 prefix) {
+        return prefixToAddress(address6NoZoneFactory, ipv6PrefixString(prefix));
     }
 
+    @Deprecated(forRemoval = true)
     public final @NonNull A6NZ ipv6AddressNoZoneFrom(final @NonNull P6 prefix) {
-        return prefixToAddress(address6NoZoneFactory, ipv6PrefixString(prefix));
+        return ipv6AddressFrom(prefix);
     }
 
     public final byte @NonNull[] ipv6AddressBytes(final @NonNull A6 addr) {
@@ -538,11 +521,11 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
     }
 
     /**
-     * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv4 address.
+     * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
      *
      * @param addr an {@link Inet6Address}
      * @return An Ipv6Prefix object
-     * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
+     * @throws IllegalArgumentException if addr is not an Inet6Address
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr) {
@@ -561,8 +544,6 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr, final int mask) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
         return prefix6Factory.newInstance(addressStringV6(addr) + '/' + mask);
     }
@@ -611,12 +592,13 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         return prefix6Factory.newInstance(addr + '/' + mask);
     }
 
-    public final @NonNull Entry<A6, Integer> splitIpv6Prefix(final @NonNull P6 prefix) {
-        return splitPrefix(address6Factory, ipv6PrefixString(prefix));
+    public final @NonNull Entry<A6NZ, Integer> splitIpv6Prefix(final @NonNull P6 prefix) {
+        return splitPrefix(address6NoZoneFactory, ipv6PrefixString(prefix));
     }
 
+    @Deprecated(forRemoval = true)
     public final @NonNull Entry<A6NZ, Integer> splitIpv6PrefixNoZone(final @NonNull P6 prefix) {
-        return splitPrefix(address6NoZoneFactory, ipv6PrefixString(prefix));
+        return splitIpv6Prefix(prefix);
     }
 
     private static <T> @NonNull T prefixToAddress(final StringValueObjectFactory<T> factory, final String str) {
@@ -648,23 +630,35 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         }
     }
 
-    private static String addressStringV4(final byte @NonNull[] bytes) {
+    static String addressStringV4(final byte @NonNull[] bytes) {
         final StringBuilder sb = new StringBuilder(15);
         appendIpv4String(sb, bytes);
         return sb.toString();
     }
 
+    private static @NonNull String addressStringV4(final InetAddress addr) {
+        requireNonNull(addr, "Address must not be null");
+        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
+        return addr.getHostAddress();
+    }
+
     private static String addressStringV6(final byte @NonNull[] bytes) {
         checkArgument(bytes.length == INET6_LENGTH, "IPv6 address length is 16 bytes");
 
         try {
-            return addressStringV6(Inet6Address.getByAddress(bytes));
+            return addressStringV6(Inet6Address.getByAddress(null, bytes, null));
         } catch (UnknownHostException e) {
             throw new IllegalArgumentException(String.format("Invalid input %s", bytes), e);
         }
     }
 
     private static String addressStringV6(final InetAddress addr) {
+        requireNonNull(addr, "Address must not be null");
+        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
+        return addressStringV6((Inet6Address) addr);
+    }
+
+    private static String addressStringV6(final Inet6Address addr) {
         return InetAddresses.toAddrString(addr);
     }