Add documentation on EthernetNetworkSpecifier API
Add javadoc on the constructor and getInterfaceName method. Fixes: 182979732 Test: m Change-Id: Iced805149a8344b953331501b48184661be0053a
This commit is contained in:
@@ -42,15 +42,22 @@ public final class EthernetNetworkSpecifier extends NetworkSpecifier implements
|
||||
@NonNull
|
||||
private final String mInterfaceName;
|
||||
|
||||
/**
|
||||
* Create a new EthernetNetworkSpecifier.
|
||||
* @param interfaceName Name of the ethernet interface the specifier refers to.
|
||||
*/
|
||||
public EthernetNetworkSpecifier(@NonNull String interfaceName) {
|
||||
Preconditions.checkStringNotEmpty(interfaceName);
|
||||
mInterfaceName = interfaceName;
|
||||
}
|
||||
|
||||
// This may be null in the future to support specifiers based on data other than the interface
|
||||
// name.
|
||||
/**
|
||||
* Get the name of the ethernet interface the specifier refers to.
|
||||
*/
|
||||
@Nullable
|
||||
public String getInterfaceName() {
|
||||
// This may be null in the future to support specifiers based on data other than the
|
||||
// interface name.
|
||||
return mInterfaceName;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user