jdk-sandbox: comparison jdk/src/share/classes/java/net/Inet6Address.java

equal deleted inserted replaced

-:226059d7b730
+:2ecc993a8e67
 * questions.
 */
 package java.net;
-import java.io.ObjectInputStream;
 import java.io.IOException;
 import java.io.InvalidObjectException;
+import java.io.ObjectInputStream;
 import java.util.Enumeration;
 /**
 * This class represents an Internet Protocol version 6 (IPv6) address.
 * Defined by <a href="http://www.ietf.org/rfc/rfc2373.txt">
 * textual data.
 *
 * <h4> Special IPv6 address </h4>
 *
 * <blockquote>
-* <table cellspacing=2 summary="Description of IPv4-mapped address"> <tr><th valign=top><i>IPv4-mapped address</i></th>
+* <table cellspacing=2 summary="Description of IPv4-mapped address">
+* <tr><th valign=top><i>IPv4-mapped address</i></th>
 *         <td>Of the form::ffff:w.x.y.z, this IPv6 address is used to
 *         represent an IPv4 address. It allows the native program to
 *         use the same address data structure and also the same
 *         socket when communicating with both IPv4 and IPv6 nodes.
 *
 *         IPv4-mapped address as input, both in byte array and text
 *         representation. However, it will be converted into an IPv4
 *         address.</td></tr>
 * </table></blockquote>
 * <p>
-* <h4> <A NAME="scoped">Textual representation of IPv6 scoped addresses</a> </h4>
+* <h4><A NAME="scoped">Textual representation of IPv6 scoped addresses</a></h4>
-* <p>
+*
-* The textual representation of IPv6 addresses as described above can be extended
+* <p> The textual representation of IPv6 addresses as described above can be
-* to specify IPv6 scoped addresses. This extension to the basic addressing architecture
+* extended to specify IPv6 scoped addresses. This extension to the basic
-* is described in [draft-ietf-ipngwg-scoping-arch-04.txt].
+* addressing architecture is described in [draft-ietf-ipngwg-scoping-arch-04.txt].
-* <p>
+*
-* Because link-local and site-local addresses are non-global, it is possible that different hosts
+* <p> Because link-local and site-local addresses are non-global, it is possible
-* may have the same destination address and may be reachable through different interfaces on the
+* that different hosts may have the same destination address and may be
-* same originating system. In this case, the originating system is said to be connected
+* reachable through different interfaces on the same originating system. In
-* to multiple zones of the same scope. In order to disambiguate which is the intended destination
+* this case, the originating system is said to be connected to multiple zones
-* zone, it is possible to append a zone identifier (or <i>scope_id</i>) to an IPv6 address.
+* of the same scope. In order to disambiguate which is the intended destination
-* <p>
+* zone, it is possible to append a zone identifier (or <i>scope_id</i>) to an
-* The general format for specifying the <i>scope_id</i> is the following:
+* IPv6 address.
+*
+* <p> The general format for specifying the <i>scope_id</i> is the following:
+*
 * <p><blockquote><i>IPv6-address</i>%<i>scope_id</i></blockquote>
 * <p> The IPv6-address is a literal IPv6 address as described above.
-* The <i>scope_id</i> refers to an interface on the local system, and it can be specified
+* The <i>scope_id</i> refers to an interface on the local system, and it can be
-* in two ways.
+* specified in two ways.
-* <p><ol><li><i>As a numeric identifier.</i> This must be a positive integer that identifies the
+* <p><ol><li><i>As a numeric identifier.</i> This must be a positive integer
-* particular interface and scope as understood by the system. Usually, the numeric
+* that identifies the particular interface and scope as understood by the
-* values can be determined through administration tools on the system. Each interface may
+* system. Usually, the numeric values can be determined through administration
-* have multiple values, one for each scope. If the scope is unspecified, then the default value
+* tools on the system. Each interface may have multiple values, one for each
-* used is zero.</li><p>
+* scope. If the scope is unspecified, then the default value used is zero.</li>
-* <li><i>As a string.</i> This must be the exact string that is returned by
+* <p><li><i>As a string.</i> This must be the exact string that is returned by
-* {@link java.net.NetworkInterface#getName()} for the particular interface in question.
+* {@link java.net.NetworkInterface#getName()} for the particular interface in
-* When an Inet6Address is created in this way, the numeric scope-id is determined at the time
+* question. When an Inet6Address is created in this way, the numeric scope-id
-* the object is created by querying the relevant NetworkInterface.</li>
+* is determined at the time the object is created by querying the relevant
-* </ol><p>
+* NetworkInterface.</li></ol>
-* Note also, that the numeric <i>scope_id</i> can be retrieved from Inet6Address instances returned from the
+*
-* NetworkInterface class. This can be used to find out the current scope ids configured on the system.
+* <p> Note also, that the numeric <i>scope_id</i> can be retrieved from
+* Inet6Address instances returned from the NetworkInterface class. This can be
+* used to find out the current scope ids configured on the system.
 * @since 1.4
 */
 public final
 class Inet6Address extends InetAddress {
 final static int INADDRSZ = 16;
 /*
 * cached scope_id - for link-local address use only.
 */
-private transient int cached_scope_id = 0;
+private transient int cached_scope_id;  // 0
 /**
 * Holds a 128-bit (16 bytes) IPv6 address.
 *
 * @serial
 */
 byte[] ipaddress;
 /**
-* scope_id. The scope specified when the object is created. If the object is created
+* scope_id. The scope specified when the object is created. If the object
-* with an interface name, then the scope_id is not determined until the time it is needed.
+* is created with an interface name, then the scope_id is not determined
-*/
+* until the time it is needed.
-private int scope_id = 0;
+*/
+private int scope_id;  // 0
 /**
 * This will be set to true when the scope_id field contains a valid
 * integer scope_id.
 */
-private boolean scope_id_set = false;
+private boolean scope_id_set;  // false
 /**
 * scoped interface. scope_id is derived from this as the scope_id of the first
 * address whose scope is the same as this address for the named interface.
 */
-private transient NetworkInterface scope_ifname = null;
+private transient NetworkInterface scope_ifname;  // null
-/**
-* set if the object is constructed with a scoped interface instead of a
-* numeric scope id.
-*/
-private boolean scope_ifname_set = false;
 private static final long serialVersionUID = 6880410070516793377L;
-/*
+// Perform native initialization
-* Perform initializations.
+static { init(); }
-*/
-static {
-init();
-}
 Inet6Address() {
 super();
 hostName = null;
 ipaddress = new byte[INADDRSZ];
 try {
 initif (hostName, addr, null);
 } catch (UnknownHostException e) {} /* cant happen if ifname is null */
 }
-Inet6Address (String hostName, byte addr[], NetworkInterface nif) throws UnknownHostException {
+Inet6Address (String hostName, byte addr[], NetworkInterface nif)
+throws UnknownHostException
+{
 initif (hostName, addr, nif);
 }
-Inet6Address (String hostName, byte addr[], String ifname) throws UnknownHostException {
+Inet6Address (String hostName, byte addr[], String ifname)
+throws UnknownHostException
+{
 initstr (hostName, addr, ifname);
 }
 /**
-* Create an Inet6Address in the exact manner of {@link InetAddress#getByAddress(String,byte[])}
+* Create an Inet6Address in the exact manner of {@link
-* except that the IPv6 scope_id is set to the value corresponding to the given interface
+* InetAddress#getByAddress(String,byte[])} except that the IPv6 scope_id is
-* for the address type specified in <code>addr</code>.
+* set to the value corresponding to the given interface for the address
-* The call will fail with an UnknownHostException if the given interface does not have a numeric
+* type specified in <code>addr</code>. The call will fail with an
+* UnknownHostException if the given interface does not have a numeric
 * scope_id assigned for the given address type (eg. link-local or site-local).
 * See <a href="Inet6Address.html#scoped">here</a> for a description of IPv6
 * scoped addresses.
 *
 * @param host the specified host
 * @param addr the raw IP address in network byte order
 * @param nif an interface this address must be associated with.
 * @return  an Inet6Address object created from the raw IP address.
-* @exception  UnknownHostException  if IP address is of illegal length, or if the interface
+* @throws  UnknownHostException
-*          does not have a numeric scope_id assigned for the given address type.
+*          if IP address is of illegal length, or if the interface does not
+*          have a numeric scope_id assigned for the given address type.
 *
 * @since 1.5
 */
+public static Inet6Address getByAddress(String host, byte[] addr,
-public static Inet6Address getByAddress(String host, byte[] addr, NetworkInterface nif)
+NetworkInterface nif)
-throws UnknownHostException {
+throws UnknownHostException
+{
 if (host != null && host.length() > 0 && host.charAt(0) == '[') {
 if (host.charAt(host.length()-1) == ']') {
 host = host.substring(1, host.length() -1);
 }
 }
 }
 throw new UnknownHostException("addr is of illegal length");
 }
 /**
-* Create an Inet6Address in the exact manner of {@link InetAddress#getByAddress(String,byte[])}
+* Create an Inet6Address in the exact manner of {@link
-* except that the IPv6 scope_id is set to the given numeric value.
+* InetAddress#getByAddress(String,byte[])} except that the IPv6 scope_id is
-* The scope_id is not checked to determine if it corresponds to any interface on the system.
+* set to the given numeric value. The scope_id is not checked to determine
+* if it corresponds to any interface on the system.
 * See <a href="Inet6Address.html#scoped">here</a> for a description of IPv6
 * scoped addresses.
 *
 * @param host the specified host
 * @param addr the raw IP address in network byte order
 * @param scope_id the numeric scope_id for the address.
 * @return  an Inet6Address object created from the raw IP address.
-* @exception  UnknownHostException  if IP address is of illegal length.
+* @throws  UnknownHostException  if IP address is of illegal length.
 *
 * @since 1.5
 */
+public static Inet6Address getByAddress(String host, byte[] addr,
-public static Inet6Address getByAddress(String host, byte[] addr, int scope_id)
+int scope_id)
-throws UnknownHostException {
+throws UnknownHostException
+{
 if (host != null && host.length() > 0 && host.charAt(0) == '[') {
 if (host.charAt(host.length()-1) == ']') {
 host = host.substring(1, host.length() -1);
 }
 }
 }
 }
 throw new UnknownHostException("addr is of illegal length");
 }
-private void initstr (String hostName, byte addr[], String ifname) throws UnknownHostException {
+private void initstr(String hostName, byte addr[], String ifname)
+throws UnknownHostException
+{
 try {
 NetworkInterface nif = NetworkInterface.getByName (ifname);
 if (nif == null) {
 throw new UnknownHostException ("no such interface " + ifname);
 }
 } catch (SocketException e) {
 throw new UnknownHostException ("SocketException thrown" + ifname);
 }
 }
-private void initif(String hostName, byte addr[],NetworkInterface nif) throws UnknownHostException {
+private void initif(String hostName, byte addr[],NetworkInterface nif)
+throws UnknownHostException
+{
 this.hostName = hostName;
 if (addr.length == INADDRSZ) { // normal IPv6 address
 family = IPv6;
 ipaddress = addr.clone();
 }
 if (nif != null) {
-this.scope_ifname = nif;
+scope_ifname = nif;
-scope_ifname_set = true;
+scope_id = deriveNumericScope(nif);
-scope_id = deriveNumericScope (nif);
 scope_id_set = true;
 }
 }
 /* check the two Ipv6 addresses and return false if they are both
 * non global address types, but not the same.
 * (ie. one is sitelocal and the other linklocal)
 * return true otherwise.
 */
 private boolean differentLocalAddressTypes(Inet6Address other) {
+if (isLinkLocalAddress() && !other.isLinkLocalAddress())
-if (isLinkLocalAddress() && !other.isLinkLocalAddress()) {
 return false;
-}
+if (isSiteLocalAddress() && !other.isSiteLocalAddress())
-if (isSiteLocalAddress() && !other.isSiteLocalAddress()) {
 return false;
-}
 return true;
 }
-private int deriveNumericScope (NetworkInterface ifc) throws UnknownHostException {
+private int deriveNumericScope(NetworkInterface ifc)
+throws UnknownHostException
+{
 Enumeration<InetAddress> addresses = ifc.getInetAddresses();
 while (addresses.hasMoreElements()) {
 InetAddress addr = addresses.nextElement();
 if (!(addr instanceof Inet6Address)) {
 continue;
 return ia6_addr.scope_id;
 }
 throw new UnknownHostException ("no scope_id found");
 }
-private int deriveNumericScope (String ifname) throws UnknownHostException {
+private int deriveNumericScope(String ifname) throws UnknownHostException {
 Enumeration<NetworkInterface> en;
 try {
 en = NetworkInterface.getNetworkInterfaces();
 } catch (SocketException e) {
-throw new UnknownHostException ("could not enumerate local network interfaces");
+throw new UnknownHostException(
+"could not enumerate local network interfaces");
 }
 while (en.hasMoreElements()) {
 NetworkInterface ifc = en.nextElement();
-if (ifc.getName().equals (ifname)) {
+if (ifc.getName().equals(ifname)) {
 Enumeration<InetAddress> addresses = ifc.getInetAddresses();
 while (addresses.hasMoreElements()) {
 InetAddress addr = addresses.nextElement();
 if (!(addr instanceof Inet6Address)) {
 continue;
 /* found a matching address - return its scope_id */
 return ia6_addr.scope_id;
 }
 }
 }
-throw new UnknownHostException ("No matching address found for interface : " +ifname);
+throw new UnknownHostException(
+"No matching address found for interface : " +ifname);
 }
 /**
 * restore the state of this object from stream
 * including the scope information, only if the
 * scoped interface name is valid on this system
 */
 private void readObject(ObjectInputStream s)
 throws IOException, ClassNotFoundException {
-scope_ifname = null;
-scope_ifname_set = false;
 s.defaultReadObject();
-if (ifname != null && !"".equals (ifname)) {
+if (ifname != null && !ifname.equals("")) {
 try {
 scope_ifname = NetworkInterface.getByName(ifname);
-if (scope_ifname == null) {
+if (scope_ifname != null) {
-/* the interface does not exist on this system, so we clear
-* the scope information completely */
-scope_id_set = false;
-scope_ifname_set = false;
-scope_id = 0;
-} else {
 try {
-scope_id = deriveNumericScope (scope_ifname);
+scope_id = deriveNumericScope(scope_ifname);
 } catch (UnknownHostException e) {
 // typically should not happen, but it may be that
 // the machine being used for deserialization has
 // the same interface name but without IPv6 configured.
 }
 /**
 * Utility routine to check if the InetAddress is an IP multicast
 * address. 11111111 at the start of the address identifies the
 * address as being a multicast address.
 *
-* @return a <code>boolean</code> indicating if the InetAddress is
+* @return a {@code boolean} indicating if the InetAddress is an IP
-* an IP multicast address
+*         multicast address
+*
 * @since JDK1.1
 */
 @Override
 public boolean isMulticastAddress() {
 return ((ipaddress[0] & 0xff) == 0xff);
 }
 /**
 * Utility routine to check if the InetAddress in a wildcard address.
-* @return a <code>boolean</code> indicating if the Inetaddress is
+*
+* @return a {@code boolean} indicating if the Inetaddress is
 *         a wildcard address.
+*
 * @since 1.4
 */
 @Override
 public boolean isAnyLocalAddress() {
 byte test = 0x00;
 }
 /**
 * Utility routine to check if the InetAddress is a loopback address.
 *
-* @return a <code>boolean</code> indicating if the InetAddress is
+* @return a {@code boolean} indicating if the InetAddress is a loopback
-* a loopback address; or false otherwise.
+*         address; or false otherwise.
+*
 * @since 1.4
 */
 @Override
 public boolean isLoopbackAddress() {
 byte test = 0x00;
 }
 /**
 * Utility routine to check if the InetAddress is an link local address.
 *
-* @return a <code>boolean</code> indicating if the InetAddress is
+* @return a {@code boolean} indicating if the InetAddress is a link local
-* a link local address; or false if address is not a link local unicast address.
+*         address; or false if address is not a link local unicast address.
+*
 * @since 1.4
 */
 @Override
 public boolean isLinkLocalAddress() {
 return ((ipaddress[0] & 0xff) == 0xfe
 }
 /**
 * Utility routine to check if the InetAddress is a site local address.
 *
-* @return a <code>boolean</code> indicating if the InetAddress is
+* @return a {@code boolean} indicating if the InetAddress is a site local
-* a site local address; or false if address is not a site local unicast address.
+*         address; or false if address is not a site local unicast address.
+*
 * @since 1.4
 */
 @Override
 public boolean isSiteLocalAddress() {
 return ((ipaddress[0] & 0xff) == 0xfe
 }
 /**
 * Utility routine to check if the multicast address has global scope.
 *
-* @return a <code>boolean</code> indicating if the address has
+* @return a {@code boolean} indicating if the address has is a multicast
-*         is a multicast address of global scope, false if it is not
+*         address of global scope, false if it is not of global scope or
-*         of global scope or it is not a multicast address
+*         it is not a multicast address
+*
 * @since 1.4
 */
 @Override
 public boolean isMCGlobal() {
 return ((ipaddress[0] & 0xff) == 0xff
 }
 /**
 * Utility routine to check if the multicast address has node scope.
 *
-* @return a <code>boolean</code> indicating if the address has
+* @return a {@code boolean} indicating if the address has is a multicast
-*         is a multicast address of node-local scope, false if it is not
+*         address of node-local scope, false if it is not of node-local
-*         of node-local scope or it is not a multicast address
+*         scope or it is not a multicast address
+*
 * @since 1.4
 */
 @Override
 public boolean isMCNodeLocal() {
 return ((ipaddress[0] & 0xff) == 0xff
 }
 /**
 * Utility routine to check if the multicast address has link scope.
 *
-* @return a <code>boolean</code> indicating if the address has
+* @return a {@code boolean} indicating if the address has is a multicast
-*         is a multicast address of link-local scope, false if it is not
+*         address of link-local scope, false if it is not of link-local
-*         of link-local scope or it is not a multicast address
+*         scope or it is not a multicast address
+*
 * @since 1.4
 */
 @Override
 public boolean isMCLinkLocal() {
 return ((ipaddress[0] & 0xff) == 0xff
 }
 /**
 * Utility routine to check if the multicast address has site scope.
 *
-* @return a <code>boolean</code> indicating if the address has
+* @return a {@code boolean} indicating if the address has is a multicast
-*         is a multicast address of site-local scope, false if it is not
+*         address of site-local scope, false if it is not  of site-local
-*         of site-local scope or it is not a multicast address
+*         scope or it is not a multicast address
+*
 * @since 1.4
 */
 @Override
 public boolean isMCSiteLocal() {
 return ((ipaddress[0] & 0xff) == 0xff
 }
 /**
 * Utility routine to check if the multicast address has organization scope.
 *
-* @return a <code>boolean</code> indicating if the address has
+* @return a {@code boolean} indicating if the address has is a multicast
-*         is a multicast address of organization-local scope,
+*         address of organization-local scope, false if it is not of
-*         false if it is not of organization-local scope
+*         organization-local scope or it is not a multicast address
-*         or it is not a multicast address
+*
 * @since 1.4
 */
 @Override
 public boolean isMCOrgLocal() {
 return ((ipaddress[0] & 0xff) == 0xff
 && (ipaddress[1] & 0x0f) == 0x08);
 }
 /**
-* Returns the raw IP address of this <code>InetAddress</code>
+* Returns the raw IP address of this {@code InetAddress} object. The result
-* object. The result is in network byte order: the highest order
+* is in network byte order: the highest order byte of the address is in
-* byte of the address is in <code>getAddress()[0]</code>.
+* {@code getAddress()[0]}.
 *
 * @return  the raw IP address of this object.
 */
 @Override
 public byte[] getAddress() {
 /**
 * Returns the numeric scopeId, if this instance is associated with
 * an interface. If no scoped_id is set, the returned value is zero.
 *
 * @return the scopeId, or zero if not set.
+*
 * @since 1.5
 */
-public int getScopeId () {
+public int getScopeId() {
 return scope_id;
 }
 /**
 * Returns the scoped interface, if this instance was created with
 * with a scoped interface.
 *
 * @return the scoped interface, or null if not set.
 * @since 1.5
 */
-public NetworkInterface getScopedInterface () {
+public NetworkInterface getScopedInterface() {
 return scope_ifname;
 }
 /**
-* Returns the IP address string in textual presentation. If the instance was created
+* Returns the IP address string in textual presentation. If the instance
-* specifying a scope identifier then the scope id is appended to the IP address preceded by
+* was created specifying a scope identifier then the scope id is appended
-* a "%" (per-cent) character. This can be either a numeric value or a string, depending on which
+* to the IP address preceded by a "%" (per-cent) character. This can be
-* was used to createthe instance.
+* either a numeric value or a string, depending on which was used to create
+* the instance.
 *
 * @return  the raw IP address in a string format.
 */
 @Override
 public String getHostAddress() {
 String s = numericToTextFormat(ipaddress);
-if (scope_ifname_set) { /* must check this first */
+if (scope_ifname != null) { /* must check this first */
 s = s + "%" + scope_ifname.getName();
 } else if (scope_id_set) {
 s = s + "%" + scope_id;
 }
 return s;
 return 0;
 }
 }
 /**
-* Compares this object against the specified object.
+* Compares this object against the specified object. The result is {@code
-* The result is <code>true</code> if and only if the argument is
+* true} if and only if the argument is not {@code null} and it represents
-* not <code>null</code> and it represents the same IP address as
+* the same IP address as this object.
-* this object.
+*
-* <p>
+* <p> Two instances of {@code InetAddress} represent the same IP address
-* Two instances of <code>InetAddress</code> represent the same IP
+* if the length of the byte arrays returned by {@code getAddress} is the
-* address if the length of the byte arrays returned by
+* same for both, and each of the array components is the same for the byte
-* <code>getAddress</code> is the same for both, and each of the
+* arrays.
-* array components is the same for the byte arrays.
 *
 * @param   obj   the object to compare against.
-* @return  <code>true</code> if the objects are the same;
+*
-*          <code>false</code> otherwise.
+* @return  {@code true} if the objects are the same; {@code false} otherwise.
+*
 * @see     java.net.InetAddress#getAddress()
 */
 @Override
 public boolean equals(Object obj) {
-if (obj == null ||
+if (obj == null || !(obj instanceof Inet6Address))
-!(obj instanceof Inet6Address))
 return false;
 Inet6Address inetAddr = (Inet6Address)obj;
 for (int i = 0; i < INADDRSZ; i++) {
 if (ipaddress[i] != inetAddr.ipaddress[i])
 return false;
 }
 /**
 * Utility routine to check if the InetAddress is an
 * IPv4 compatible IPv6 address.
 *
-* @return a <code>boolean</code> indicating if the InetAddress is
+* @return a {@code boolean} indicating if the InetAddress is an IPv4
-* an IPv4 compatible IPv6 address; or false if address is IPv4 address.
+*         compatible IPv6 address; or false if address is IPv4 address.
+*
 * @since 1.4
 */
 public boolean isIPv4CompatibleAddress() {
 if ((ipaddress[0] == 0x00) && (ipaddress[1] == 0x00) &&
 (ipaddress[2] == 0x00) && (ipaddress[3] == 0x00) &&
 return false;
 }
 // Utilities
 private final static int INT16SZ = 2;
 /*
 * Convert IPv6 binary address into presentation (printable) format.
 *
 * @param src a byte array representing the IPv6 numeric address
 * @return a String representing an IPv6 address in
 *         textual representation format
 * @since 1.4
 */
-static String numericToTextFormat(byte[] src)
+static String numericToTextFormat(byte[] src) {
-{
+StringBuilder sb = new StringBuilder(39);
-StringBuffer sb = new StringBuffer(39);
 for (int i = 0; i < (INADDRSZ / INT16SZ); i++) {
 sb.append(Integer.toHexString(((src[i<<1]<<8) & 0xff00)
 | (src[(i<<1)+1] & 0xff)));
 if (i < (INADDRSZ / INT16SZ) -1 ) {
 sb.append(":");
 * which is not serializable
 */
 private synchronized void writeObject(java.io.ObjectOutputStream s)
 throws IOException
 {
-if (scope_ifname_set) {
+if (scope_ifname != null)
 ifname = scope_ifname.getName();
-}
 s.defaultWriteObject();
 }
 }

changeset 14783	2ecc993a8e67
parent 10596	39b3a979e600
child 16870	f35b2bd19761