LineageOS/android_packages_modules_Connectivity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation on EthernetNetworkSpecifier API

Browse Source 
Add javadoc on the constructor and getInterfaceName method.

Fixes: 182979732
Test: m
Change-Id: Iced805149a8344b953331501b48184661be0053a
This commit is contained in:
Remi NGUYEN VAN
2021-04-08 15:32:08 +09:00
parent cdbde20884
commit 212d6930cc
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
core/java/android/net/EthernetNetworkSpecifier.java
View File

@@ -42,15 +42,22 @@ public final class EthernetNetworkSpecifier extends NetworkSpecifier implements
@NonNull @NonNull
private final String mInterfaceName; private final String mInterfaceName;
/**
* Create a new EthernetNetworkSpecifier.
* @param interfaceName Name of the ethernet interface the specifier refers to.
*/
public EthernetNetworkSpecifier(@NonNull String interfaceName) { public EthernetNetworkSpecifier(@NonNull String interfaceName) {
Preconditions.checkStringNotEmpty(interfaceName); Preconditions.checkStringNotEmpty(interfaceName);
mInterfaceName = 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 @Nullable
public String getInterfaceName() { public String getInterfaceName() {
// This may be null in the future to support specifiers based on data other than the
// interface name.
return mInterfaceName; return mInterfaceName;
} }