frameworks/base/core/java/android/widget/Filterable.java

   1 /*
   2  * Copyright (C) 2007 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package android.widget;
  18
  19 /**
  20  * <p>Defines a filterable behavior. A filterable class can have its data
  21  * constrained by a filter. Filterable classes are usually
  22  * {@link android.widget.Adapter} implementations.</p>
  23  *
  24  * @see android.widget.Filter
  25  */
  26 public interface Filterable {
  27     /**
  28      * <p>Returns a filter that can be used to constrain data with a filtering
  29      * pattern.</p>
  30      *
  31      * <p>This method is usually implemented by {@link android.widget.Adapter}
  32      * classes.</p>
  33      *
  34      * @return a filter used to constrain data
  35      */
  36     Filter getFilter();
  37 }