Top Fields Constructors Methods
io.vertx.core.net.impl

public Class SocketAddressImpl

extends Object
implements SocketAddress
Class Inheritance
All Implemented Interfaces
io.vertx.core.net.SocketAddress
Imports
io.netty.util.NetUtil, io.vertx.core.VertxException, io.vertx.core.impl.Arguments, io.vertx.core.net.SocketAddress, java.net.Inet6Address, .InetAddress, .InetSocketAddress, .UnknownHostException, java.util.Objects

Author
Tim Fox

Field Summary

Modifier and TypeField and Description
private final String
private final String
private final InetAddress
private final String
private final int

Constructor Summary

AccessConstructor and Description
public
public
SocketAddressImpl(int port, String host)

public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
host()

Implements io.vertx.core.net.SocketAddress.host.

Returns the host name when available or the IP address in string representation.

public String
hostAddress()

Implements io.vertx.core.net.SocketAddress.hostAddress.

Returns the host IP address when available or null as a String.

public String
hostName()

Implements io.vertx.core.net.SocketAddress.hostName.

Returns the host name when available or null Domain socket address returns null.

public InetAddress
public boolean
public boolean
public String
public int
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

hostback to summary
private final String host
hostNameback to summary
private final String hostName
ipAddressback to summary
private final InetAddress ipAddress
pathback to summary
private final String path
portback to summary
private final int port

Constructor Detail

SocketAddressImplback to summary
public SocketAddressImpl(InetSocketAddress address)
SocketAddressImplback to summary
public SocketAddressImpl(int port, String host)
SocketAddressImplback to summary
public SocketAddressImpl(String path)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
hostback to summary
public String host()

Implements io.vertx.core.net.SocketAddress.host.

Doc from io.vertx.core.net.SocketAddress.host.

Returns the host name when available or the IP address in string representation.
Domain socket address returns null.

Returns:String

the host address

hostAddressback to summary
public String hostAddress()

Implements io.vertx.core.net.SocketAddress.hostAddress.

Doc from io.vertx.core.net.SocketAddress.hostAddress.

Returns the host IP address when available or null as a String.
Domain socket address returns null.

Returns:String

the host address

Annotations
@Override
hostNameback to summary
public String hostName()

Implements io.vertx.core.net.SocketAddress.hostName.

Doc from io.vertx.core.net.SocketAddress.hostName.

Returns the host name when available or null
Domain socket address returns null.

Returns:String

the host name

Annotations
@Override
ipAddressback to summary
public InetAddress ipAddress()
isDomainSocketback to summary
public boolean isDomainSocket()

Implements io.vertx.core.net.SocketAddress.isDomainSocket.

Returns:boolean

Doc from io.vertx.core.net.SocketAddress.isDomainSocket.

true for an domain socket address

Annotations
@Override
isInetSocketback to summary
public boolean isInetSocket()

Implements io.vertx.core.net.SocketAddress.isInetSocket.

Returns:boolean

Doc from io.vertx.core.net.SocketAddress.isInetSocket.

true for an inet socket address

Annotations
@Override
pathback to summary
public String path()

Implements io.vertx.core.net.SocketAddress.path.

Returns:String

Doc from io.vertx.core.net.SocketAddress.path.

the domain socket path or null for inet socket address, empty path represents unnamed domain socket addresses.

Annotations
@Override
portback to summary
public int port()

Implements io.vertx.core.net.SocketAddress.port.

Returns:int

Doc from io.vertx.core.net.SocketAddress.port.

the address port or -1 for a domain socket

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object