Safe Args Generated Classes failing Jetpack API Lint check [185843837]

Fixed

Bug

Status Update

No update yet.

Description

ds...@google.com

created issue #1

Apr 20, 2021 01:02AM

Component used: Navigation, Safe Args plugin

Version used: 2.3.4

Hi!

I'm working on creating a debug view for AppSearch as a Jetpack library. I'm using Navigation component for managing switching between fragments. I'm using the Safe Args plugin for passing in arguments to a destination fragment. However, the classes the Safe Args plugin generates in the build tree are causing the Jetpack API lint check to fail:

> Task :appsearch:appsearch-debug-view:generateApi

../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:119: error: Builder must be final: androidx.appsearch.debugview.view.DocumentFragmentArgs.Builder [StaticFinalBuilder]
../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:165: error: Getter should be on the built object, not the builder: method androidx.appsearch.debugview.view.DocumentFragmentArgs.Builder.getDocumentUri() [GetterOnBuilder]
../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:171: error: Getter should be on the built object, not the builder: method androidx.appsearch.debugview.view.DocumentFragmentArgs.Builder.getDocumentNamespace() [GetterOnBuilder]
../../../../out/androidx/appsearch/appsearch-debug-view/build/generated/source/navigation-args/release/androidx/appsearch/debugview/view/DocumentFragmentArgs.java:123: error: Missing nullability o    Your change has API lint issues. Fix the code according to the messages above.

    If a check is broken, suppress it in code in Kotlin with @Suppress("id")/@get:Suppress("id")
    and in Java with @SuppressWarnings("id") and file bug to
    https://issuetracker.google.com/issues/new?component=739152&template=1344623

    If you are doing a refactoring or suppression above does not work, use ./gradlew updateApiLintBaseline

The class generating these errors is attached. I would appreciate it if the Lint issues could be resolved so I can continue using Safe Args!

DocumentFragmentArgs.java

6 KB

View

Download

Comments

il...@google.com <il...@google.com> #2Apr 20, 2021 04:53PM

Assigned to jb...@google.com.

Project: platform/frameworks/support
Branch: androidx-main

commit ef4bd54e5dec9e9e8e5e510baeabc4ff00ef77cd
Author: Sherry Hu <shuanghu@google.com>
Date: Thu Jun 17 11:53:51 2021

Add AbstractListDetailFragment

Bug: 191276636
Test: Will test in sample application and unit tests.
Relnote: Added new AbstractListDetailFragment
Change-Id: Iac4be7b764ced86cdbff3c696c2cbdf2741eb81c

M navigation/navigation-fragment/api/current.txt
M navigation/navigation-fragment/api/public_plus_experimental_current.txt
M navigation/navigation-fragment/api/restricted_current.txt
M navigation/navigation-fragment/build.gradle
A navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/AbstractListDetailFragment.kt
A navigation/navigation-fragment/src/main/res/layout/abstract_list_detail_fragment.xml
M settings.gradle

https://android-review.googlesource.com/1740053

ap...@google.com <ap...@google.com> #3Aug 18, 2021 08:07PM

Project: platform/frameworks/support
Branch: androidx-main

commit b151f42998cdae5c2d906e745185aaa9049b6e4b
Author: Sherry Hu <shuanghu@google.com>
Date: Thu Jun 17 20:30:18 2021

Add sample application for two-pane navigation.

Bug: 191276636
Test: run sample application.
Change-Id: I6d746f28ae2f076c86b79de5980b43b84b0ea366

M navigation/integration-tests/testapp/src/main/java/androidx/navigation/testapp/MainFragment.kt
A navigation/integration-tests/testapp/src/main/java/androidx/navigation/testapp/TwoPaneAdapter.kt
A navigation/integration-tests/testapp/src/main/java/androidx/navigation/testapp/TwoPaneFragment.kt
M navigation/integration-tests/testapp/src/main/res/layout/bottom_bar_menu.xml
A navigation/integration-tests/testapp/src/main/res/layout/list_pane.xml
A navigation/integration-tests/testapp/src/main/res/layout/list_pane_row_item.xml
A navigation/integration-tests/testapp/src/main/res/layout/two_pane_fragment.xml
M navigation/integration-tests/testapp/src/main/res/menu/menu_bottom_nav.xml
M navigation/integration-tests/testapp/src/main/res/navigation/nav_main.xml
A navigation/integration-tests/testapp/src/main/res/navigation/two_pane_navigation.xml
M navigation/integration-tests/testapp/src/main/res/values/donottranslate-strings.xml

https://android-review.googlesource.com/1740716

jb...@google.com <jb...@google.com> #4Aug 18, 2021 08:11PM

Marked as fixed.

As part of Navigation 2.4.0-alpha04, the navigation-fragment artifact now offers an AbstractListDetailFragment that implements a two pane layout:

the left (start) list pane is provided by subclasses by overriding onCreateListPaneView()
the right (end) detail pane is implemented as a NavHostFragment, controllable by overriding onCreateDetailPaneNavHostFragment()

It automatically handles the system back button (i.e., going back from the detail pane to the list pane on phones).

Issue 185843837

Description

Issue summary

Comments

il...@google.com <il...@google.com> #2Apr 20, 2021 04:53PM

ap...@google.com <ap...@google.com> #3Aug 18, 2021 08:07PM

jb...@google.com <jb...@google.com> #4Aug 18, 2021 08:11PM

Add comment

Issue metadata