1 /*
2 * Copyright (C) 2008, Google Inc.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.patch;
45
46 import org.eclipse.jgit.lib.Constants;
47 import org.eclipse.jgit.util.RawParseUtils;
48
49 /** An error in a patch script */
50 public class FormatError {
51 /** Classification of an error. */
52 public static enum Severity {
53 /** The error is unexpected, but can be worked around. */
54 WARNING,
55
56 /** The error indicates the script is severely flawed. */
57 ERROR;
58 }
59
60 private final byte[] buf;
61
62 private final int offset;
63
64 private final Severity severity;
65
66 private final String message;
67
68 FormatError(final byte[] buffer, final int ptr, final Severity sev,
69 final String msg) {
70 buf = buffer;
71 offset = ptr;
72 severity = sev;
73 message = msg;
74 }
75
76 /** @return the severity of the error. */
77 public Severity getSeverity() {
78 return severity;
79 }
80
81 /** @return a message describing the error. */
82 public String getMessage() {
83 return message;
84 }
85
86 /** @return the byte buffer holding the patch script. */
87 public byte[] getBuffer() {
88 return buf;
89 }
90
91 /** @return byte offset within {@link #getBuffer()} where the error is */
92 public int getOffset() {
93 return offset;
94 }
95
96 /** @return line of the patch script the error appears on. */
97 public String getLineText() {
98 final int eol = RawParseUtils.nextLF(buf, offset);
99 return RawParseUtils.decode(Constants.CHARSET, buf, offset, eol);
100 }
101
102 @Override
103 public String toString() {
104 final StringBuilder r = new StringBuilder();
105 r.append(getSeverity().name().toLowerCase());
106 r.append(": at offset "); //$NON-NLS-1$
107 r.append(getOffset());
108 r.append(": "); //$NON-NLS-1$
109 r.append(getMessage());
110 r.append("\n"); //$NON-NLS-1$
111 r.append(" in "); //$NON-NLS-1$
112 r.append(getLineText());
113 return r.toString();
114 }
115 }