Top Description Fields Constructors Methods
org.newsclub.net.unix

public final Class HostAndPort

extends Object
Class Inheritance
Imports
java.io.UnsupportedEncodingException, java.net.SocketException, .URI, .URLDecoder, .URLEncoder, java.util.Objects, java.util.regex.Matcher, .Pattern

Hostname and port.
Author
Christian Kohlschütter

Field Summary

Modifier and TypeField and Description
private final String
private static final Pattern
private final int

Constructor Summary

AccessConstructor and Description
public
HostAndPort(String
The hostname.
hostname
,
int
The port, or -1 for "no port".
port
)

Creates a new hostname and port combination.

Method Summary

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

Overrides java.lang.Object.equals.

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

public String

Returns:

The hostname.
getHostname
()

Returns the hostname.

public int

Returns:

The port.
getPort
()

Returns the port, or -1 for "no port specified".

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static HostAndPort

Returns:

The parsed HostAndPort instance.
parseFrom
(URI
The URI to extract from.
u
)

Tries to extract hostname and port information from the given URI.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public URI

Returns:

The URI.
toURI
(String
The scheme to use.
scheme
)

Returns a URI with this hostname and port.

public URI

Returns:

The URI.
toURI
(String
The scheme to use.
scheme
,
URI
The template. or null.
template
)

Returns a URI with this hostname and port, potentially reusing other URI parameters from the given template URI (authority, path, query, fragment).

public URI

Returns:

The URI.
toURI
(String
The scheme to use.
scheme
,
String
The raw authority field, or null.
rawAuthority
,
String
The raw path field, or null.
rawPath
,
String
The raw query field, or null.
rawQuery
,
String
The raw fragment field, or null.
rawFragment
)

Returns a URI with this hostname and port, potentially using other URI parameters from the given set of parameters.

private static String
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

hostnameback to summary
private final String hostname
PAT_HOST_AND_PORTback to summary
private static final Pattern PAT_HOST_AND_PORT
portback to summary
private final int port

Constructor Detail

HostAndPortback to summary
public HostAndPort(String hostname, int port)

Creates a new hostname and port combination.

Parameters
hostname:String

The hostname.

port:int

The port, or -1 for "no port".

Method Detail

equalsback to summary
public boolean equals(Object obj)

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
obj: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
getHostnameback to summary
public String getHostname()

Returns the hostname.

Returns:String

The hostname.

getPortback to summary
public int getPort()

Returns the port, or -1 for "no port specified".

Returns:int

The port.

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
parseFromback to summary
public static HostAndPort parseFrom(URI u) throws SocketException

Tries to extract hostname and port information from the given URI.

Parameters
u:URI

The URI to extract from.

Returns:HostAndPort

The parsed HostAndPort instance.

Exceptions
SocketException:
on error.
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

Annotations
@Override
toURIback to summary
public URI toURI(String scheme)

Returns a URI with this hostname and port.

Parameters
scheme:String

The scheme to use.

Returns:URI

The URI.

toURIback to summary
public URI toURI(String scheme, URI template)

Returns a URI with this hostname and port, potentially reusing other URI parameters from the given template URI (authority, path, query, fragment).

Parameters
scheme:String

The scheme to use.

template:URI

The template. or null.

Returns:URI

The URI.

toURIback to summary
public URI toURI(String scheme, String rawAuthority, String rawPath, String rawQuery, String rawFragment)

Returns a URI with this hostname and port, potentially using other URI parameters from the given set of parameters.

Parameters
scheme:String

The scheme to use.

rawAuthority:String

The raw authority field, or null.

rawPath:String

The raw path field, or null.

rawQuery:String

The raw query field, or null.

rawFragment:String

The raw fragment field, or null.

Returns:URI

The URI.

urlEncodeback to summary
private static String urlEncode(String s)