libjava/java/net/InetSocketAddress.java

   1 /* InetSocketAddress.java --
   2    Copyright (C) 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.net;
  39
  40 /**
  41  * InetSocketAddress instances represent socket addresses
  42  * in the java.nio package. They encapsulate a InetAddress and
  43  * a port number.
  44  *
  45  * @since 1.4
  46  */
  47
  48 public class InetSocketAddress extends SocketAddress
  49 {
  50   /**
  51    * Compatible with JDK 1.4+
  52    */
  53   private static final long serialVersionUID = 5076001401234631237L;
  54
  55   /**
  56    * Name of host.
  57    */
  58   private String hostname;
  59
  60   /**
  61    * Address of host.
  62    */
  63   private InetAddress addr;
  64
  65   /**
  66    * Port of host.
  67    */
  68   private int port;
  69
  70   /**
  71    * Constructs an InetSocketAddress instance.
  72    *
  73    * @param addr Address of the socket
  74    * @param port Port if the socket
  75    *
  76    * @exception IllegalArgumentException If the port number is illegel
  77    */
  78   public InetSocketAddress(InetAddress addr, int port)
  79     throws IllegalArgumentException
  80   {
  81     if (port < 0 || port > 65535)
  82       throw new IllegalArgumentException ("Bad port number: " + port);
  83
  84     if (addr == null)
  85       addr = InetAddress.ANY_IF;
  86
  87     this.addr = addr;
  88     this.port = port;
  89     this.hostname = addr.getHostName ();
  90   }
  91
  92   /**
  93    * Constructs an InetSocketAddress instance.
  94    *
  95    * @param port Port if the socket
  96    *
  97    * @exception IllegalArgumentException If the port number is illegal
  98    */
  99   public InetSocketAddress(int port)
 100     throws IllegalArgumentException
 101   {
 102     this ((InetAddress) null, port);
 103   }
 104
 105   /**
 106    * Constructs an InetSocketAddress instance.
 107    *
 108    * @param addr Address of the socket
 109    * @param port Port if the socket
 110    *
 111    * @exception IllegalArgumentException If the port number is illegal
 112    */
 113   public InetSocketAddress(String hostname, int port)
 114     throws IllegalArgumentException
 115   {
 116     if (hostname == null)
 117       throw new IllegalArgumentException ("Null host name value");
 118
 119     if (port < 0 || port > 65535)
 120       throw new IllegalArgumentException ("Bad port number: " + port);
 121
 122     this.port = port;
 123     this.hostname = hostname;
 124
 125     try
 126       {
 127         this.addr = InetAddress.getByName(hostname);
 128       }
 129     catch (Exception e) // UnknownHostException, SecurityException
 130       {
 131         this.addr = null;
 132       }
 133   }
 134
 135   /**
 136    * Test if obj is a <code>InetSocketAddress</code> and
 137    * has the same address and port
 138    *
 139    * @param obj The obj to compare this address with.
 140    *
 141    * @return True if obj is equal.
 142    */
 143   public final boolean equals (Object obj)
 144   {
 145     // InetSocketAddress objects are equal when addr and port are equal.
 146     // The hostname may differ.
 147
 148     if (obj instanceof InetSocketAddress)
 149       {
 150         InetSocketAddress sa = (InetSocketAddress) obj;
 151
 152         if (addr == null && sa.addr != null)
 153           return false;
 154         else if (addr == null && sa.addr == null)
 155           return hostname.equals (sa.hostname) && sa.port == port;
 156         else
 157           return addr.equals (sa.addr) && sa.port == port;
 158       }
 159
 160     return false;
 161   }
 162
 163   /**
 164    * Returns the <code>InetAddress</code> or
 165    * <code>null</code> if its unresolved
 166    *
 167    * @return The IP address of this address.
 168    */
 169   public final InetAddress getAddress()
 170   {
 171     return addr;
 172   }
 173
 174   /**
 175    * Returns <code>hostname</code>
 176    *
 177    * @return The hostname of this address.
 178    */
 179   public final String getHostName()
 180   {
 181     return hostname;
 182   }
 183
 184   /**
 185    * Returns the <code>port</code>
 186    *
 187    * @return The port of this address.
 188    */
 189   public final int getPort()
 190   {
 191     return port;
 192   }
 193
 194   /**
 195    * Returns the hashcode of the <code>InetSocketAddress</code>
 196    *
 197    * @return The hashcode for this address.
 198    */
 199   public final int hashCode()
 200   {
 201     return port + addr.hashCode();
 202   }
 203
 204   /**
 205    * Checks wether the address has been resolved or not
 206    *
 207    * @return True if address is unresolved.
 208    */
 209   public final boolean isUnresolved()
 210   {
 211     return addr == null;
 212   }
 213
 214   /**
 215    * Returns the <code>InetSocketAddress</code> as string
 216    *
 217    * @return A string represenation of this address.
 218    */
 219   public String toString()
 220   {
 221     return (addr == null ? hostname : addr.getHostName()) + ":" + port;
 222   }
 223 }