Class Protocol

java.lang.Object

jnr.netdb.Protocol

public final class Protocol
extends Object

An entry in the system protocol database

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	Protocol.ProtocolDBSingletonHolder	Holds the global lazily-loaded instance of the ProtocolDB

Field Summary

Fields

Modifier and Type	Field	Description
private final Collection<String>	aliases	All the aliases for this protocol
private final int	proto
private final String	protocolName	Official protocol name

Constructor Summary

Constructors

Constructor	Description
Protocol(String name, int proto, Collection<String> aliases)

Method Summary

Modifier and Type	Method	Description
final Collection<String>	getAliases()	Returns a list of aliases this Protocol is also known by.
final String	getName()	Returns the official IANA name of this Protocol
final int	getProto()	Returns the official IANA protocol number for this Protocol
static final Protocol	getProtocolByName(String name)	Locates a protocol by name.
static final Protocol	getProtocolByNumber(int proto)	Locates a protocol by number.
private static final ProtocolsDB	getProtocolDB()	Returns the currently loaded ProtocolDB
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

protocolName

private final String protocolName

Official protocol name

proto

private final int proto

aliases

private final Collection<String> aliases

All the aliases for this protocol

Constructor Details

Protocol

Protocol(String name,
 int proto,
 Collection<String> aliases)

Method Details

getProtocolByName

public static final Protocol getProtocolByName(String name)

Locates a protocol by name.

Parameters:

name - the official IANA name for the protocol, or an alias.

Returns:

a Protocol instance, or null if the protocol could not be found.

getProtocolByNumber

public static final Protocol getProtocolByNumber(int proto)

Locates a protocol by number.

Parameters:

proto - the internet protocol number of the protocol.

Returns:

a Protocol instance, or null if the protocol could not be found.

getName

public final String getName()

Returns the official IANA name of this Protocol

Returns:

The name of this Protocol as a String

getProto

public final int getProto()

Returns the official IANA protocol number for this Protocol

Returns:

The protocol number for this Protocol as an int

getAliases

public final Collection<String> getAliases()

Returns a list of aliases this Protocol is also known by.

Returns:

A Collection of Strings for aliases this Protocol

getProtocolDB

private static final ProtocolsDB getProtocolDB()

Returns the currently loaded ProtocolDB

Returns:

an instance of ProtocolDB

toString

public String toString()

Overrides:

toString in class Object