Top Description Fields Constructors Methods
org.apache.hc.core5.net

public final Class URIAuthority

extends Object
implements NamedEndpoint, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.apache.hc.core5.net.NamedEndpoint
Annotations
@Contract
threading:IMMUTABLE
Imports
java.io.Serializable, java.net.URISyntaxException, java.util.Objects, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.util.Args, .LangUtils, .TextUtils, .Tokenizer

Represents authority component of request java.net.URI.
Since
5.0

Field Summary

Modifier and TypeField and Description
private final Host
private static final long
private final String

Constructor Summary

AccessConstructor and Description
public
URIAuthority(final String userInfo, final String hostname, final int port)

Constructs a new instance.

public
URIAuthority(final String hostname, final int port)

public
URIAuthority(final String userInfo, final Host host)

public
URIAuthority(final Host host)

public
URIAuthority(final String userInfo, final NamedEndpoint endpoint)

public
URIAuthority(final NamedEndpoint namedEndpoint)

public
URIAuthority(final String hostname)

Method Summary

Modifier and TypeMethod and Description
public static URIAuthority
create(final String s)

Creates a URIAuthority instance from a string.

public boolean
equals(final Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
pack-priv static void
format(final StringBuilder buf, final URIAuthority uriAuthority)

pack-priv static String
format(final URIAuthority uriAuthority)

public String
getHostName()

Implements org.apache.hc.core5.net.NamedEndpoint.getHostName.

Returns name (IP or DNS name).
public int
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
pack-priv static URIAuthority
parse(final CharSequence s, final Tokenizer.Cursor cursor)

pack-priv static URIAuthority
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 Host host
serialVersionUIDback to summary
private static final long serialVersionUID
userInfoback to summary
private final String userInfo

Constructor Detail

URIAuthorityback to summary
public URIAuthority(final String userInfo, final String hostname, final int port)

Constructs a new instance.

Exceptions
IllegalArgumentException:
If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.
URIAuthorityback to summary
public URIAuthority(final String hostname, final int port)
URIAuthorityback to summary
public URIAuthority(final String userInfo, final Host host)
Since
5.2
URIAuthorityback to summary
public URIAuthority(final Host host)
Since
5.2
URIAuthorityback to summary
public URIAuthority(final String userInfo, final NamedEndpoint endpoint)
Since
5.2
URIAuthorityback to summary
public URIAuthority(final NamedEndpoint namedEndpoint)
URIAuthorityback to summary
public URIAuthority(final String hostname)

Method Detail

createback to summary
public static URIAuthority create(final String s) throws URISyntaxException

Creates a URIAuthority instance from a string. Text may not contain any blanks.

equalsback to summary
public boolean equals(final 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
formatback to summary
pack-priv static void format(final StringBuilder buf, final URIAuthority uriAuthority)
formatback to summary
pack-priv static String format(final URIAuthority uriAuthority)
getHostNameback to summary
public String getHostName()

Implements org.apache.hc.core5.net.NamedEndpoint.getHostName.

Doc from org.apache.hc.core5.net.NamedEndpoint.getHostName.

Returns name (IP or DNS name).

Returns:String

the host name (IP or DNS name)

Annotations
@Override
getPortback to summary
public int getPort()

Implements org.apache.hc.core5.net.NamedEndpoint.getPort.

Doc from org.apache.hc.core5.net.NamedEndpoint.getPort.

Returns the port.

Returns:int

the host port, or -1 if not set

Annotations
@Override
getUserInfoback to summary
public String getUserInfo()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
parseback to summary
pack-priv static URIAuthority parse(final CharSequence s, final Tokenizer.Cursor cursor) throws URISyntaxException
parseback to summary
pack-priv static URIAuthority parse(final CharSequence s) throws URISyntaxException
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override