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