com.garygregory.jcommander.converters.net

Class NetworkInterfaceNameConverter

java.lang.Object

com.beust.jcommander.converters.BaseConverter<T>

com.garygregory.jcommander.converters.AbstractBaseConverter<NetworkInterface>

com.garygregory.jcommander.converters.net.NetworkInterfaceNameConverter

All Implemented Interfaces:

com.beust.jcommander.IStringConverter<NetworkInterface>

public class NetworkInterfaceNameConverter
extends AbstractBaseConverter<NetworkInterface>

Converts a String into a NetworkInterface.

For a description of the format, see NetworkInterface.getByName(String).

Example:

 @Parameter(names = { "--networkInterface" }, converter = NetworkInterfaceConverter.class)
 private NetworkInterface networkInterface;
 

Since:

1.0.0

Author:

Gary Gregory

See Also:

NetworkInterface, NetworkInterface.getByName(String)

Field Summary

Fields inherited from class com.garygregory.jcommander.converters.AbstractBaseConverter

failOnNull, targetClass

Constructor Summary

Constructors

Constructor and Description
NetworkInterfaceNameConverter(String optionName) Constructs a converter.

Method Summary

Modifier and Type	Method and Description
protected NetworkInterface	convertImpl(String value) Converts a value.

Methods inherited from class com.garygregory.jcommander.converters.AbstractBaseConverter

convert, getErrorString, isSingle, newParameterException, newParameterException, split, toInt, toURI

Methods inherited from class com.beust.jcommander.converters.BaseConverter

getErrorString, getOptionName

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkInterfaceNameConverter

public NetworkInterfaceNameConverter(String optionName)

Constructs a converter.

Parameters:

optionName - The option name, may be null.

Method Detail

convertImpl

protected NetworkInterface convertImpl(String value)
                                throws SocketException

Description copied from class: AbstractBaseConverter

Converts a value.

Specified by:

convertImpl in class AbstractBaseConverter<NetworkInterface>

Parameters:

value - the value to convert

Returns:

the converted value

Throws:

SocketException