1 /*
2 * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
3 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.revwalk;
46
47 /** Sorting strategies supported by {@link RevWalk} and {@link ObjectWalk}. */
48 public enum RevSort {
49 /**
50 * No specific sorting is requested.
51 * <p>
52 * Applications should not rely upon the ordering produced by this strategy.
53 * Any ordering in the output is caused by low level implementation details
54 * and may change without notice.
55 */
56 NONE,
57
58 /**
59 * Sort by commit time, descending (newest first, oldest last).
60 * <p>
61 * This strategy can be combined with {@link #TOPO}.
62 */
63 COMMIT_TIME_DESC,
64
65 /**
66 * Topological sorting (all children before parents).
67 * <p>
68 * This strategy can be combined with {@link #COMMIT_TIME_DESC}.
69 */
70 TOPO,
71
72 /**
73 * Flip the output into the reverse ordering.
74 * <p>
75 * This strategy can be combined with the others described by this type as
76 * it is usually performed at the very end.
77 */
78 REVERSE,
79
80 /**
81 * Include {@link RevFlag#UNINTERESTING} boundary commits after all others.
82 * In {@link ObjectWalk}, objects associated with such commits (trees,
83 * blobs), and all other objects marked explicitly as UNINTERESTING are also
84 * included.
85 * <p>
86 * A boundary commit is a UNINTERESTING parent of an interesting commit that
87 * was previously output.
88 */
89 BOUNDARY;
90 }