Update javadoc for newly unused API methods.
These methods will continue to be functional, and will serve older SDKs. This migration isn't connected to an API related flag, but rather the UI functionality.
Test: builds
Flag: EXEMPT DOCS_ONLY
Bug: 433491133
Bug: 408241976
Relnote: N/a
Change-Id: Id240720d64879cdc704db187788cb340fccf7d1f
diff --git a/framework-s/java/android/safetycenter/SafetyCenterData.java b/framework-s/java/android/safetycenter/SafetyCenterData.java
index 7cae061..7a03515 100644
--- a/framework-s/java/android/safetycenter/SafetyCenterData.java
+++ b/framework-s/java/android/safetycenter/SafetyCenterData.java
@@ -165,7 +165,12 @@
return mEntriesOrGroups;
}
- /** Returns the list of {@link SafetyCenterStaticEntryGroup} objects in the Safety Center. */
+ /**
+ * Returns the list of {@link SafetyCenterStaticEntryGroup} objects in the Safety Center.
+ *
+ * <p>Note: When Safety Center UI is fully migrated to the Settings app, the UI won't rely on
+ * this data anymore.
+ */
@NonNull
public List<SafetyCenterStaticEntryGroup> getStaticEntryGroups() {
return mStaticEntryGroups;
diff --git a/framework-s/java/android/safetycenter/config/SafetySource.java b/framework-s/java/android/safetycenter/config/SafetySource.java
index ff0c66e..b6c7c92 100644
--- a/framework-s/java/android/safetycenter/config/SafetySource.java
+++ b/framework-s/java/android/safetycenter/config/SafetySource.java
@@ -477,6 +477,9 @@
* that is accessible from the same resource context that was used to load the Safety Center
* configuration. The id is {@link Resources#ID_NULL} when search terms are not provided.
*
+ * <p>Note: When Safety Center UI is fully migrated to the Settings app, the UI won't rely on
+ * this data anymore.
+ *
* @throws UnsupportedOperationException if the source is of type {@link
* SafetySource#SAFETY_SOURCE_TYPE_ISSUE_ONLY}
*/
diff --git a/framework-s/java/android/safetycenter/config/SafetySourcesGroup.java b/framework-s/java/android/safetycenter/config/SafetySourcesGroup.java
index 9f9ff96..9865c7a 100644
--- a/framework-s/java/android/safetycenter/config/SafetySourcesGroup.java
+++ b/framework-s/java/android/safetycenter/config/SafetySourcesGroup.java
@@ -180,7 +180,12 @@
mSafetySources = safetySources;
}
- /** Returns the type of this safety sources group. */
+ /**
+ * Returns the type of this safety sources group.
+ *
+ * <p>Note: When Safety Center UI is fully migrated to the Settings app, the UI won't rely on
+ * this data anymore.
+ */
@SafetySourceGroupType
public int getType() {
return mType;
@@ -190,6 +195,9 @@
* Returns the id of this safety sources group.
*
* <p>The id is unique among safety sources groups in a Safety Center configuration.
+ *
+ * <p>Note: When Safety Center UI is fully migrated to the Settings app, the UI won't rely on
+ * this data anymore.
*/
@NonNull
public String getId() {
@@ -202,6 +210,9 @@
* <p>The id refers to a string resource that is either accessible from any resource context or
* that is accessible from the same resource context that was used to load the Safety Center
* configuration. The id is {@link Resources#ID_NULL} when a title is not provided.
+ *
+ * <p>Note: When Safety Center UI is fully migrated to the Settings app, the UI won't rely on
+ * this data anymore.
*/
@StringRes
public int getTitleResId() {
@@ -214,6 +225,9 @@
* <p>The id refers to a string resource that is either accessible from any resource context or
* that is accessible from the same resource context that was used to load the Safety Center
* configuration. The id is {@link Resources#ID_NULL} when a summary is not provided.
+ *
+ * <p>Note: When Safety Center UI is fully migrated to the Settings app, the UI won't rely on
+ * this data anymore.
*/
@StringRes
public int getSummaryResId() {
@@ -226,6 +240,9 @@
* <p>If set to a value other than {@link SafetySourcesGroup#STATELESS_ICON_TYPE_NONE}, the icon
* specified will be displayed for collapsible groups when all the sources contained in the
* group are stateless.
+ *
+ * <p>Note: When Safety Center UI is fully migrated to the Settings app, the UI won't rely on
+ * this data anymore.
*/
@StatelessIconType
public int getStatelessIconType() {
