WrongNestedHierarchyViolation.kt

/*
 * Copyright 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.fragment.app.strictmode

import androidx.fragment.app.Fragment

/**
 * See [FragmentStrictMode.Policy.Builder.detectWrongNestedHierarchy].
 */
class WrongNestedHierarchyViolation internal constructor(
    fragment: Fragment,
    /**
     * Gets the expected parent [Fragment] of the fragment causing the Violation.
     */
    val expectedParentFragment: Fragment,
    /**
     * Gets the unique ID of the container that the [Fragment] causing
     * the Violation would have been added to.
     */
    val containerId: Int
) : Violation(
    fragment,
    "Attempting to nest fragment $fragment within the view " +
        "of parent fragment $expectedParentFragment via container with ID $containerId " +
        "without using parent's childFragmentManager"
)