1 /*
2  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package java.net;
27 
28 /**
29  * This class represents a Network Interface address. In short it's an
30  * IP address, a subnet mask and a broadcast address when the address is
31  * an IPv4 one. An IP address and a network prefix length in the case
32  * of IPv6 address.
33  *
34  * @see java.net.NetworkInterface
35  * @since 1.6
36  */
37 public class InterfaceAddress {
38     private InetAddress address = null;
39     private Inet4Address broadcast = null;
40     private short        maskLength = 0;
41 
42     /*
43      * Package private constructor. Can't be built directly, instances are
44      * obtained through the NetworkInterface class.
45      */
InterfaceAddress()46     InterfaceAddress() {
47     }
48 
49     // BEGIN Android-added: Rewrote NetworkInterface on top of Libcore.io.
InterfaceAddress(InetAddress address, Inet4Address broadcast, InetAddress netmask)50     InterfaceAddress(InetAddress address, Inet4Address broadcast, InetAddress netmask) {
51         this.address = address;
52         this.broadcast = broadcast;
53         this.maskLength = countPrefixLength(netmask);
54     }
55 
56     /**
57      * Counts the prefix length for the netmask address.
58      *
59      * A valid netmask address must start with a continuous sequence of 1, followed by a continuous
60      * sequence of 0.
61      */
countPrefixLength(InetAddress netmask)62     private short countPrefixLength(InetAddress netmask) {
63         short count = 0;
64         for (byte b : netmask.getAddress()) {
65             for (; b != 0; b <<= 1, ++count);
66         }
67         return count;
68     }
69     // END Android-added: Rewrote NetworkInterface on top of Libcore.io.
70 
71     /**
72      * Returns an {@code InetAddress} for this address.
73      *
74      * @return the {@code InetAddress} for this address.
75      */
getAddress()76     public InetAddress getAddress() {
77         return address;
78     }
79 
80     /**
81      * Returns an {@code InetAddress} for the broadcast address
82      * for this InterfaceAddress.
83      * <p>
84      * Only IPv4 networks have broadcast address therefore, in the case
85      * of an IPv6 network, {@code null} will be returned.
86      *
87      * @return the {@code InetAddress} representing the broadcast
88      *         address or {@code null} if there is no broadcast address.
89      */
getBroadcast()90     public InetAddress getBroadcast() {
91         return broadcast;
92     }
93 
94     /**
95      * Returns the network prefix length for this address. This is also known
96      * as the subnet mask in the context of IPv4 addresses.
97      * Typical IPv4 values would be 8 (255.0.0.0), 16 (255.255.0.0)
98      * or 24 (255.255.255.0). <p>
99      * Typical IPv6 values would be 128 (::1/128) or 10 (fe80::203:baff:fe27:1243/10)
100      *
101      * @return a {@code short} representing the prefix length for the
102      *         subnet of that address.
103      */
getNetworkPrefixLength()104      public short getNetworkPrefixLength() {
105         return maskLength;
106     }
107 
108     /**
109      * Compares this object against the specified object.
110      * The result is {@code true} if and only if the argument is
111      * not {@code null} and it represents the same interface address as
112      * this object.
113      * <p>
114      * Two instances of {@code InterfaceAddress} represent the same
115      * address if the InetAddress, the prefix length and the broadcast are
116      * the same for both.
117      *
118      * @param   obj   the object to compare against.
119      * @return  {@code true} if the objects are the same;
120      *          {@code false} otherwise.
121      * @see     java.net.InterfaceAddress#hashCode()
122      */
equals(Object obj)123     public boolean equals(Object obj) {
124         if (!(obj instanceof InterfaceAddress)) {
125             return false;
126         }
127         InterfaceAddress cmp = (InterfaceAddress) obj;
128         if ( !(address == null ? cmp.address == null : address.equals(cmp.address)) )
129             return false;
130         if ( !(broadcast  == null ? cmp.broadcast == null : broadcast.equals(cmp.broadcast)) )
131             return false;
132         if (maskLength != cmp.maskLength)
133             return false;
134         return true;
135     }
136 
137     /**
138      * Returns a hashcode for this Interface address.
139      *
140      * @return  a hash code value for this Interface address.
141      */
hashCode()142     public int hashCode() {
143         return address.hashCode() + ((broadcast != null) ? broadcast.hashCode() : 0) + maskLength;
144     }
145 
146     /**
147      * Converts this Interface address to a {@code String}. The
148      * string returned is of the form: InetAddress / prefix length [ broadcast address ].
149      *
150      * @return  a string representation of this Interface address.
151      */
toString()152     public String toString() {
153         return address + "/" + maskLength + " [" + broadcast + "]";
154     }
155 
156 }
157