View Javadoc
1   /*
2    * Copyright (C) 2011, Tomasz Zarna <Tomasz.Zarna@pl.ibm.com> and others
3    *
4    * This program and the accompanying materials are made available under the
5    * terms of the Eclipse Distribution License v. 1.0 which is available at
6    * https://www.eclipse.org/org/documents/edl-v10.php.
7    *
8    * SPDX-License-Identifier: BSD-3-Clause
9    */
10  package org.eclipse.jgit.revwalk.filter;
11  
12  import java.io.IOException;
13  
14  import org.eclipse.jgit.errors.IncorrectObjectTypeException;
15  import org.eclipse.jgit.errors.MissingObjectException;
16  import org.eclipse.jgit.errors.StopWalkException;
17  import org.eclipse.jgit.internal.JGitText;
18  import org.eclipse.jgit.revwalk.RevCommit;
19  import org.eclipse.jgit.revwalk.RevWalk;
20  
21  /**
22   * Filter that includes commits after a configured number are skipped.
23   */
24  public class SkipRevFilter extends RevFilter {
25  
26  	private final int skip;
27  
28  	private int count;
29  
30  	/**
31  	 * Create a new skip filter.
32  	 *
33  	 * @param skip
34  	 *            the number of commits to skip
35  	 * @return a new filter
36  	 */
37  	public static RevFilter create(int skip) {
38  		if (skip < 0)
39  			throw new IllegalArgumentException(
40  					JGitText.get().skipMustBeNonNegative);
41  		return new SkipRevFilter(skip);
42  	}
43  
44  	private SkipRevFilter(int skip) {
45  		this.skip = skip;
46  	}
47  
48  	/** {@inheritDoc} */
49  	@Override
50  	public boolean include(RevWalk walker, RevCommit cmit)
51  			throws StopWalkException, MissingObjectException,
52  			IncorrectObjectTypeException, IOException {
53  		if (skip > count++)
54  			return false;
55  		return true;
56  	}
57  
58  	/** {@inheritDoc} */
59  	@Override
60  	public RevFilter clone() {
61  		return new SkipRevFilter(skip);
62  	}
63  }