public interface

Resettable

 androidx.recyclerview.selection.Resettable

Subclasses:

DefaultSelectionTracker<K>

Gradle dependencies

compile group: 'androidx.recyclerview', name: 'recyclerview-selection', version: '1.2.0-alpha01'

  • groupId: androidx.recyclerview
  • artifactId: recyclerview-selection
  • version: 1.2.0-alpha01

Artifact androidx.recyclerview:recyclerview-selection:1.2.0-alpha01 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.recyclerview:recyclerview-selection com.android.support:recyclerview-selection

Overview

Represents an object that can be reset and can advise on it's need to be reset.

Calling Resettable.isResetRequired() on an instance of Resettable should always return false when called immediately after Resettable.reset() has been called.

Summary

Methods
public booleanisResetRequired()

public voidreset()

Resets the object state.

Methods

public boolean isResetRequired()

Returns:

true if the object requires reset.

public void reset()

Resets the object state.

Source

/*
 * Copyright 2019 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.recyclerview.selection;

import static androidx.annotation.RestrictTo.Scope.LIBRARY;

import androidx.annotation.RestrictTo;

/**
 * Represents an object that can be reset and can advise on it's
 * need to be reset.
 *
 * <p>Calling {@link #isResetRequired()} on an instance of {@link Resettable}
 * should always return false when called immediately after {@link #reset()}
 * has been called.
 *
 * @hide
 */
@RestrictTo(LIBRARY)
public interface Resettable {

    /**
     * @return true if the object requires reset.
     */
    boolean isResetRequired();

    /**
     * Resets the object state.
     */
    void reset();
}