libjava/classpath/java/net/InetSocketAddress.java

   1 /* InetSocketAddress.java --
   2    Copyright (C) 2002, 2006  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., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 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 /**
  42  * InetSocketAddress instances represent socket addresses
  43  * in the java.nio package. They encapsulate a InetAddress and
  44  * a port number.
  45  *
  46  * @since 1.4
  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   }
  90
  91   /**
  92    * Constructs an InetSocketAddress instance.
  93    *
  94    * @param port Port if the socket
  95    *
  96    * @exception IllegalArgumentException If the port number is illegal
  97    */
  98   public InetSocketAddress(int port) throws IllegalArgumentException
  99   {
 100     this((InetAddress) null, port);
 101   }
 102
 103   /**
 104    * Constructs an InetSocketAddress instance.
 105    *
 106    * @param hostname The hostname for the socket address
 107    * @param port The port for the socket address
 108    *
 109    * @exception IllegalArgumentException If the port number is illegal or
 110    * the hostname argument is null
 111    */
 112   public InetSocketAddress(String hostname, int port)
 113   {
 114     this(hostname, port, true);
 115   }
 116
 117   /**
 118    * Constructs an InetSocketAddress instance.
 119    *
 120    * @param hostname The hostname for the socket address
 121    * @param port The port for the socket address
 122    * @param resolve <code>true</code> if the address has to be resolved,
 123    * <code>false</code> otherwise
 124    *
 125    * @exception IllegalArgumentException If the port number is illegal or
 126    * the hostname argument is null
 127    */
 128   private InetSocketAddress(String hostname, int port, boolean resolve)
 129   {
 130     if (hostname == null)
 131       throw new IllegalArgumentException("Null host name value");
 132
 133     if (port < 0 || port > 65535)
 134       throw new IllegalArgumentException("Bad port number: " + port);
 135
 136     this.port = port;
 137     this.hostname = hostname;
 138     this.addr = null;
 139
 140     if (resolve)
 141     {
 142       try
 143         {
 144           this.addr = InetAddress.getByName(hostname);
 145         }
 146       catch (Exception e) // UnknownHostException, SecurityException
 147         {
 148           // Do nothing here. this.addr is already set to null.
 149         }
 150     }
 151
 152   }
 153
 154   /**
 155    * Creates an unresolved <code>InetSocketAddress</code> object.
 156    *
 157    * @param hostname The hostname for the socket address
 158    * @param port The port for the socket address
 159    *
 160    * @exception IllegalArgumentException If the port number is illegal or
 161    * the hostname argument is null
 162    *
 163    * @since 1.5
 164    */
 165   public static InetSocketAddress createUnresolved(String hostname, int port)
 166   {
 167     return new InetSocketAddress(hostname, port, false);
 168   }
 169
 170   /**
 171    * Test if obj is a <code>InetSocketAddress</code> and
 172    * has the same address and port
 173    *
 174    * @param obj The obj to compare this address with.
 175    *
 176    * @return True if obj is equal.
 177    */
 178   public final boolean equals(Object obj)
 179   {
 180     // InetSocketAddress objects are equal when addr and port are equal.
 181     // The hostname may differ.
 182     if (obj instanceof InetSocketAddress)
 183       {
 184         InetSocketAddress sa = (InetSocketAddress) obj;
 185
 186         if (addr == null && sa.addr != null)
 187           return false;
 188         else if (addr == null && sa.addr == null) // we know hostname != null
 189           return hostname.equals(sa.hostname) && sa.port == port;
 190         else
 191           return addr.equals(sa.addr) && sa.port == port;
 192       }
 193
 194     return false;
 195   }
 196
 197   /**
 198    * Returns the <code>InetAddress</code> or
 199    * <code>null</code> if its unresolved
 200    *
 201    * @return The IP address of this address.
 202    */
 203   public final InetAddress getAddress()
 204   {
 205     return addr;
 206   }
 207
 208   /**
 209    * Returns <code>hostname</code>
 210    *
 211    * @return The hostname of this address.
 212    */
 213   public final String getHostName()
 214   {
 215     if (hostname == null) // we know addr != null
 216       hostname = addr.getHostName();
 217
 218     return hostname;
 219   }
 220
 221   /**
 222    * Returns the <code>port</code>
 223    *
 224    * @return The port of this address.
 225    */
 226   public final int getPort()
 227   {
 228     return port;
 229   }
 230
 231   /**
 232    * Returns the hashcode of the <code>InetSocketAddress</code>
 233    *
 234    * @return The hashcode for this address.
 235    */
 236   public final int hashCode()
 237   {
 238     return port + addr.hashCode();
 239   }
 240
 241   /**
 242    * Checks wether the address has been resolved or not
 243    *
 244    * @return True if address is unresolved.
 245    */
 246   public final boolean isUnresolved()
 247   {
 248     return addr == null;
 249   }
 250
 251   /**
 252    * Returns the <code>InetSocketAddress</code> as string
 253    *
 254    * @return A string representation of this address.
 255    */
 256   public String toString()
 257   {
 258     // Note: if addr is null, then hostname != null.
 259     return (addr == null ? hostname : addr.toString()) + ":" + port;
 260   }
 261 }