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

Address API review comments for DhcpOption object

Browse Source 
Add a link to javadoc for the allowed types and use the lint annotation
to suppress compilation errors instead of modifying the baseline file.

Bug: 213240318

Test: atest FrameworksNetTests
Test: atest NetworkStackTests

Signed-off-by: Mingguang Xu <mingguangxu@google.com>
Change-Id: I2a83cc19baa25068326517b30a9afdea19536af9
This commit is contained in:
Mingguang Xu
2022-01-26 15:37:57 -08:00
parent 2a947ceb50
commit 6914a16c95
2 changed files with 5 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
framework/api/module-lib-lint-baseline.txt
View File

@@ -1,7 +0,0 @@
// Baseline format: 1.0
NoByteOrShort: android.net.DhcpOption#DhcpOption(byte, byte[]) parameter #0:
Should avoid odd sized primitives; use `int` instead of `byte` in parameter type in android.net.DhcpOption(byte type, byte[] value)
NoByteOrShort: android.net.DhcpOption#describeContents():
Should avoid odd sized primitives; use `int` instead of `byte` in method android.net.DhcpOption.describeContents()
NoByteOrShort: android.net.DhcpOption#getType():
Should avoid odd sized primitives; use `int` instead of `byte` in method android.net.DhcpOption.getType()

7
framework/src/android/net/DhcpOption.java
View File

@@ -18,6 +18,7 @@ package android.net;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SuppressLint;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
@@ -35,12 +36,13 @@ public final class DhcpOption implements Parcelable {
/**
* Constructs a DhcpOption object.
*
* @param type the type of this option
* @param type the type of this option. For more information, see
* https://www.iana.org/assignments/bootp-dhcp-parameters/bootp-dhcp-parameters.xhtml.
* @param value the value of this option. If {@code null}, DHCP packets containing this option
* will include the option type in the Parameter Request List. Otherwise, DHCP
* packets containing this option will include the option in the options section.
*/
public DhcpOption(byte type, @Nullable byte[] value) {
public DhcpOption(@SuppressLint("NoByteOrShort") byte type, @Nullable byte[] value) {
mType = type;
mValue = value;
}
@@ -69,6 +71,7 @@ public final class DhcpOption implements Parcelable {
};
/** Get the type of DHCP option */
@SuppressLint("NoByteOrShort")
public byte getType() {
return mType;
}