CacheBuilderRegistry.java

/*
 * Copyright 2000-2009 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.lang.cacheBuilder;

import com.intellij.openapi.components.ServiceManager;
import com.intellij.openapi.fileTypes.FileType;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * The cache builder registry allows to register custom cache builders for file types which
 * are not based on a language. For language file types, the words scanner should be returned
 * from {@link com.intellij.lang.findUsages.FindUsagesProvider#getWordsScanner()}.
 *
 * @author yole
 */
public abstract class CacheBuilderRegistry {
  public static CacheBuilderRegistry getInstance() {
    return ServiceManager.getService(CacheBuilderRegistry.class);
  }

  /**
   * Registers a cache builder for the specified file type.
   *
   * @param fileType the file type for which the cache builder is registered.
   * @param cacheBuilder the cache builder to use for the specified file type.
   */
  @Deprecated
  public abstract void registerCacheBuilder(@NotNull FileType fileType, WordsScanner cacheBuilder);

  /**
   * Returns the cache builder registered for the specified file type.
   *
   * @param fileType the file type for which the cache builder is registered.
   * @return the cache builder, or null if none was registered.
   */
  @Nullable
  public abstract WordsScanner getCacheBuilder(@NotNull FileType fileType);
}