CommitTimeRevFilter.java
/*
* Copyright (C) 2009, Mark Struberg <struberg@yahoo.de>
* Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.revwalk.filter;
import java.io.IOException;
import java.util.Date;
import org.eclipse.jgit.errors.IncorrectObjectTypeException;
import org.eclipse.jgit.errors.MissingObjectException;
import org.eclipse.jgit.errors.StopWalkException;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;
/**
* Selects commits based upon the commit time field.
*/
public abstract class CommitTimeRevFilter extends RevFilter {
/**
* Create a new filter to select commits before a given date/time.
*
* @param ts
* the point in time to cut on.
* @return a new filter to select commits on or before <code>ts</code>.
*/
public static final RevFilter before(Date ts) {
return before(ts.getTime());
}
/**
* Create a new filter to select commits before a given date/time.
*
* @param ts
* the point in time to cut on, in milliseconds
* @return a new filter to select commits on or before <code>ts</code>.
*/
public static final RevFilter before(long ts) {
return new Before(ts);
}
/**
* Create a new filter to select commits after a given date/time.
*
* @param ts
* the point in time to cut on.
* @return a new filter to select commits on or after <code>ts</code>.
*/
public static final RevFilter after(Date ts) {
return after(ts.getTime());
}
/**
* Create a new filter to select commits after a given date/time.
*
* @param ts
* the point in time to cut on, in milliseconds.
* @return a new filter to select commits on or after <code>ts</code>.
*/
public static final RevFilter after(long ts) {
return new After(ts);
}
/**
* Create a new filter to select commits after or equal a given date/time <code>since</code>
* and before or equal a given date/time <code>until</code>.
*
* @param since the point in time to cut on.
* @param until the point in time to cut off.
* @return a new filter to select commits between the given date/times.
*/
public static final RevFilter between(Date since, Date until) {
return between(since.getTime(), until.getTime());
}
/**
* Create a new filter to select commits after or equal a given date/time <code>since</code>
* and before or equal a given date/time <code>until</code>.
*
* @param since the point in time to cut on, in milliseconds.
* @param until the point in time to cut off, in millisconds.
* @return a new filter to select commits between the given date/times.
*/
public static final RevFilter between(long since, long until) {
return new Between(since, until);
}
final int when;
CommitTimeRevFilter(long ts) {
when = (int) (ts / 1000);
}
/** {@inheritDoc} */
@Override
public RevFilter clone() {
return this;
}
/** {@inheritDoc} */
@Override
public boolean requiresCommitBody() {
return false;
}
private static class Before extends CommitTimeRevFilter {
Before(long ts) {
super(ts);
}
@Override
public boolean include(RevWalk walker, RevCommit cmit)
throws StopWalkException, MissingObjectException,
IncorrectObjectTypeException, IOException {
return cmit.getCommitTime() <= when;
}
@SuppressWarnings("nls")
@Override
public String toString() {
return super.toString() + "(" + new Date(when * 1000L) + ")";
}
}
private static class After extends CommitTimeRevFilter {
After(long ts) {
super(ts);
}
@Override
public boolean include(RevWalk walker, RevCommit cmit)
throws StopWalkException, MissingObjectException,
IncorrectObjectTypeException, IOException {
// Since the walker sorts commits by commit time we can be
// reasonably certain there is nothing remaining worth our
// scanning if this commit is before the point in question.
//
if (cmit.getCommitTime() < when)
throw StopWalkException.INSTANCE;
return true;
}
@SuppressWarnings("nls")
@Override
public String toString() {
return super.toString() + "(" + new Date(when * 1000L) + ")";
}
}
private static class Between extends CommitTimeRevFilter {
private final int until;
Between(long since, long until) {
super(since);
this.until = (int) (until / 1000);
}
@Override
public boolean include(RevWalk walker, RevCommit cmit)
throws StopWalkException, MissingObjectException,
IncorrectObjectTypeException, IOException {
return cmit.getCommitTime() <= until && cmit.getCommitTime() >= when;
}
@SuppressWarnings("nls")
@Override
public String toString() {
return super.toString() + "(" + new Date(when * 1000L) + " - "
+ new Date(until * 1000L) + ")";
}
}
}