VcsLogBranchFilter.java

/*
 * Copyright 2000-2014 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.vcs.log;

import org.jetbrains.annotations.NotNull;

import java.util.Collection;

/**
 * Tells to filter by branches with given names.
 */
public interface VcsLogBranchFilter extends VcsLogFilter {
  /**
   * Tells if a branch matches the filter.
   *
   * @param name branch name.
   * @return true if a branch matches the filter, false otherwise.
   */
  boolean matches(@NotNull String name);

  /**
   * Text presentation for the filter (to display in filter popup).
   *
   * @return text presentation for the filter.
   */
  @NotNull
  Collection<String> getTextPresentation();
}