org.apache.hc.core5.net

Class URIAuthority

java.lang.Object

org.apache.hc.core5.net.URIAuthority

All Implemented Interfaces:

Serializable, NamedEndpoint

@Contract(threading=IMMUTABLE)
public final class URIAuthority
extends Object
implements NamedEndpoint, Serializable

Represents authority component of request URI.

Since:

5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
URIAuthority(Host host) Constructs a new instance.
URIAuthority(NamedEndpoint namedEndpoint) Constructs a new instance.
URIAuthority(String hostName) Constructs a new instance.
URIAuthority(String userInfo, Host host) Constructs a new instance.
URIAuthority(String hostName, int port) Constructs a new instance.
URIAuthority(String userInfo, NamedEndpoint endpoint) Constructs a new instance.
URIAuthority(String userInfo, String hostName, int port) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
static URIAuthority	create(String s) Creates a URIAuthority instance from a string.
boolean	equals(Object obj)
String	getHostName() Returns name (IP or DNS name).
int	getPort() Returns the port.
String	getUserInfo() Gets the user info String.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

URIAuthority

public URIAuthority(String userInfo,
                    String hostName,
                    int port)

Constructs a new instance.

Parameters:

userInfo - The user info, may be null.

hostName - The host name, not null.

port - The port value, between 0 and 65535, inclusive. -1 indicates the scheme default port.

Throws:

NullPointerException - If the name is null.

IllegalArgumentException - If the port is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

URIAuthority

public URIAuthority(String hostName,
                    int port)

Constructs a new instance.

Parameters:

hostName - The host name, not null.

port - The port value, between 0 and 65535, inclusive. -1 indicates the scheme default port.

Throws:

NullPointerException - If the name is null.

IllegalArgumentException - If the port is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

URIAuthority

public URIAuthority(String userInfo,
                    Host host)

Constructs a new instance.

Parameters:

userInfo - The user info, may be null.

host - The host, never null.

Throws:

NullPointerException - if the host is null.

Since:

5.2

URIAuthority

public URIAuthority(Host host)

Constructs a new instance.

Parameters:

host - The host, never null.

Throws:

NullPointerException - if the host is null.

Since:

5.2

URIAuthority

public URIAuthority(String userInfo,
                    NamedEndpoint endpoint)

Constructs a new instance.

Parameters:

userInfo - The user info, may be null.

endpoint - The named end-point, never null.

Throws:

NullPointerException - If the end-point is null.

NullPointerException - If the end-point name is null.

IllegalArgumentException - If the end-point port is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

Since:

5.2

URIAuthority

public URIAuthority(NamedEndpoint namedEndpoint)

Constructs a new instance.

Parameters:

namedEndpoint - The named end-point, never null.

Throws:

NullPointerException - If the end-point is null.

NullPointerException - If the end-point name is null.

IllegalArgumentException - If the end-point port is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

URIAuthority

public URIAuthority(String hostName)

Constructs a new instance.

Parameters:

hostName - The host name, not null.

Throws:

NullPointerException - If the name is null.

Method Detail

create

public static URIAuthority create(String s)
                           throws URISyntaxException

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

Parameters:

s - The value to parse

Returns:

The parsed URIAuthority.

Throws:

URISyntaxException - Thrown if a string could not be parsed as a URIAuthority.

getUserInfo

public String getUserInfo()

Gets the user info String.

Returns:

the user info String.

getHostName

public String getHostName()

Description copied from interface: NamedEndpoint

Returns name (IP or DNS name).

Specified by:

getHostName in interface NamedEndpoint

Returns:

the host name (IP or DNS name)

getPort

public int getPort()

Description copied from interface: NamedEndpoint

Returns the port.

Specified by:

getPort in interface NamedEndpoint

Returns:

the host port, or -1 if not set

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object