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 static java.nio.charset.StandardCharsets.UTF_8;
47
48 import java.util.Locale;
49
50 import org.eclipse.jgit.util.RawParseUtils;
51
52 /**
53 * An error in a patch script
54 */
55 public class FormatError {
56 /** Classification of an error. */
57 public static enum Severity {
58 /** The error is unexpected, but can be worked around. */
59 WARNING,
60
61 /** The error indicates the script is severely flawed. */
62 ERROR;
63 }
64
65 private final byte[] buf;
66
67 private final int offset;
68
69 private final Severity severity;
70
71 private final String message;
72
73 FormatError(final byte[] buffer, final int ptr, final Severity sev,
74 final String msg) {
75 buf = buffer;
76 offset = ptr;
77 severity = sev;
78 message = msg;
79 }
80
81 /**
82 * Get the severity of the error.
83 *
84 * @return the severity of the error.
85 */
86 public Severity getSeverity() {
87 return severity;
88 }
89
90 /**
91 * Get a message describing the error.
92 *
93 * @return a message describing the error.
94 */
95 public String getMessage() {
96 return message;
97 }
98
99 /**
100 * Get the byte buffer holding the patch script.
101 *
102 * @return the byte buffer holding the patch script.
103 */
104 public byte[] getBuffer() {
105 return buf;
106 }
107
108 /**
109 * Get byte offset within {@link #getBuffer()} where the error is.
110 *
111 * @return byte offset within {@link #getBuffer()} where the error is.
112 */
113 public int getOffset() {
114 return offset;
115 }
116
117 /**
118 * Get line of the patch script the error appears on.
119 *
120 * @return line of the patch script the error appears on.
121 */
122 public String getLineText() {
123 final int eol = RawParseUtils.nextLF(buf, offset);
124 return RawParseUtils.decode(UTF_8, buf, offset, eol);
125 }
126
127 /** {@inheritDoc} */
128 @Override
129 public String toString() {
130 final StringBuilder r = new StringBuilder();
131 r.append(getSeverity().name().toLowerCase(Locale.ROOT));
132 r.append(": at offset "); //$NON-NLS-1$
133 r.append(getOffset());
134 r.append(": "); //$NON-NLS-1$
135 r.append(getMessage());
136 r.append("\n"); //$NON-NLS-1$
137 r.append(" in "); //$NON-NLS-1$
138 r.append(getLineText());
139 return r.toString();
140 }
141 }