org.spearce.jgit/src/org/spearce/jgit/patch/FormatError.java

   1 /*
   2  * Copyright (C) 2008, Google Inc.
   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.patch;
  39
  40 import org.spearce.jgit.lib.Constants;
  41 import org.spearce.jgit.util.RawParseUtils;
  42
  43 /** An error in a patch script */
  44 public class FormatError {
  45         /** Classification of an error. */
  46         public static enum Severity {
  47                 /** The error is unexpected, but can be worked around. */
  48                 WARNING,
  49
  50                 /** The error indicates the script is severely flawed. */
  51                 ERROR;
  52         }
  53
  54         private final byte[] buf;
  55
  56         private final int offset;
  57
  58         private final Severity severity;
  59
  60         private final String message;
  61
  62         FormatError(final byte[] buffer, final int ptr, final Severity sev,
  63                         final String msg) {
  64                 buf = buffer;
  65                 offset = ptr;
  66                 severity = sev;
  67                 message = msg;
  68         }
  69
  70         /** @return the severity of the error. */
  71         public Severity getSeverity() {
  72                 return severity;
  73         }
  74
  75         /** @return a message describing the error. */
  76         public String getMessage() {
  77                 return message;
  78         }
  79
  80         /** @return the byte buffer holding the patch script. */
  81         public byte[] getBuffer() {
  82                 return buf;
  83         }
  84
  85         /** @return byte offset within {@link #getBuffer()} where the error is */
  86         public int getOffset() {
  87                 return offset;
  88         }
  89
  90         /** @return line of the patch script the error appears on. */
  91         public String getLineText() {
  92                 final int eol = RawParseUtils.nextLF(buf, offset);
  93                 return RawParseUtils.decode(Constants.CHARSET, buf, offset, eol);
  94         }
  95
  96         @Override
  97         public String toString() {
  98                 final StringBuilder r = new StringBuilder();
  99                 r.append(getSeverity().name().toLowerCase());
 100                 r.append(": at offset ");
 101                 r.append(getOffset());
 102                 r.append(": ");
 103                 r.append(getMessage());
 104                 r.append("\n");
 105                 r.append("  in ");
 106                 r.append(getLineText());
 107                 return r.toString();
 108         }
 109 }