Searchable.java

/*
 * Copyright 2000-2017 JetBrains s.r.o.
 *
 * 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 com.intellij.ui.tree;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.concurrency.Promise;

import javax.swing.tree.TreePath;

/**
 * @author Sergey.Malenkov
 */
public interface Searchable {
  /**
   * Starts searching by the specified object.
   *
   * @param object an object to identify a tree path
   * @return a {@code Promise} containing a search result
   * @see Identifiable#getUniqueID
   */
  @NotNull
  Promise<TreePath> getTreePath(Object object);
}