From 6914a16c95238a5e34bf0eaa61c86468ec79e82d Mon Sep 17 00:00:00 2001 From: Mingguang Xu Date: Wed, 26 Jan 2022 15:37:57 -0800 Subject: [PATCH] Address API review comments for DhcpOption object 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 Change-Id: I2a83cc19baa25068326517b30a9afdea19536af9 --- framework/api/module-lib-lint-baseline.txt | 7 ------- framework/src/android/net/DhcpOption.java | 7 +++++-- 2 files changed, 5 insertions(+), 9 deletions(-) delete mode 100644 framework/api/module-lib-lint-baseline.txt diff --git a/framework/api/module-lib-lint-baseline.txt b/framework/api/module-lib-lint-baseline.txt deleted file mode 100644 index c7b0db5fb3..0000000000 --- a/framework/api/module-lib-lint-baseline.txt +++ /dev/null @@ -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() diff --git a/framework/src/android/net/DhcpOption.java b/framework/src/android/net/DhcpOption.java index a125290d3f..b30470a2f1 100644 --- a/framework/src/android/net/DhcpOption.java +++ b/framework/src/android/net/DhcpOption.java @@ -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; }