org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryState.java

   1 /*
   2  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.lib;
  39
  40 /**
  41  * Important state of the repository that affects what can and cannot bed
  42  * done. This is things like unhandles conflicted merges and unfinished rebase.
  43  */
  44 public enum RepositoryState {
  45         /**
  46          * A safe state for working normally
  47          * */
  48         SAFE {
  49                 public boolean canCheckout() { return true; }
  50                 public boolean canResetHead() { return true; }
  51                 public boolean canCommit() { return true; }
  52                 public String getDescription() { return "Normal"; }
  53         },
  54
  55         /** An unfinished merge. Must resole or reset before continuing normally
  56          */
  57         MERGING {
  58                 public boolean canCheckout() { return false; }
  59                 public boolean canResetHead() { return false; }
  60                 public boolean canCommit() { return false; }
  61                 public String getDescription() { return "Conflicts"; }
  62         },
  63
  64         /**
  65          * An unfinished rebase. Must resolve, skip or abort before normal work can take place
  66          */
  67         REBASING {
  68                 public boolean canCheckout() { return false; }
  69                 public boolean canResetHead() { return false; }
  70                 public boolean canCommit() { return true; }
  71                 public String getDescription() { return "Rebase/Apply mailbox"; }
  72         },
  73
  74         /**
  75          * An unfinished rebase with merge. Must resolve, skip or abort before normal work can take place
  76          */
  77         REBASING_MERGE {
  78                 public boolean canCheckout() { return false; }
  79                 public boolean canResetHead() { return false; }
  80                 public boolean canCommit() { return true; }
  81                 public String getDescription() { return "Rebase w/merge"; }
  82         },
  83
  84         /**
  85          * An unfinished interactive rebase. Must resolve, skip or abort before normal work can take place
  86          */
  87         REBASING_INTERACTIVE {
  88                 public boolean canCheckout() { return false; }
  89                 public boolean canResetHead() { return false; }
  90                 public boolean canCommit() { return true; }
  91                 public String getDescription() { return "Rebase interactive"; }
  92         },
  93
  94         /**
  95          * Bisecting being done. Normal work may continue but is discouraged
  96          */
  97         BISECTING {
  98                 /* Changing head is a normal operation when bisecting */
  99                 public boolean canCheckout() { return true; }
 100
 101                 /* Do not reset, checkout instead */
 102                 public boolean canResetHead() { return false; }
 103
 104                 /* Actually it may make sense, but for now we err on the side of caution */
 105                 public boolean canCommit() { return false; }
 106
 107                 public String getDescription() { return "Bisecting"; }
 108         };
 109
 110         /**
 111          * @return true if changing HEAD is sane.
 112          */
 113         public abstract boolean canCheckout();
 114
 115         /**
 116          * @return true if we can commit
 117          */
 118         public abstract boolean canCommit();
 119
 120         /**
 121          * @return true if reset to another HEAD is considered SAFE
 122          */
 123         public abstract boolean canResetHead();
 124
 125         /**
 126          * @return a human readable description of the state.
 127          */
 128         public abstract String getDescription();
 129 }