
org.elasticsearch.common.ParsingException Maven / Gradle / Ivy
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.common;
import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.rest.RestStatus;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentLocation;
import org.elasticsearch.xcontent.XContentParser;
import java.io.IOException;
/**
* Exception that can be used when parsing queries with a given {@link
* XContentParser}.
* Can contain information about location of the error.
*/
public class ParsingException extends ElasticsearchException {
protected static final int UNKNOWN_POSITION = -1;
private final int lineNumber;
private final int columnNumber;
public ParsingException(XContentLocation contentLocation, String msg, Object... args) {
this(contentLocation, msg, null, args);
}
public ParsingException(XContentLocation contentLocation, String msg, Throwable cause, Object... args) {
super(msg, cause, args);
int lineNumber = UNKNOWN_POSITION;
int columnNumber = UNKNOWN_POSITION;
if (contentLocation != null) {
lineNumber = contentLocation.lineNumber();
columnNumber = contentLocation.columnNumber();
}
this.columnNumber = columnNumber;
this.lineNumber = lineNumber;
}
/**
* This constructor is provided for use in unit tests where a
* {@link XContentParser} may not be available
*/
public ParsingException(int line, int col, String msg, Throwable cause) {
super(msg, cause);
this.lineNumber = line;
this.columnNumber = col;
}
public ParsingException(StreamInput in) throws IOException {
super(in);
lineNumber = in.readInt();
columnNumber = in.readInt();
}
/**
* Line number of the location of the error
*
* @return the line number or -1 if unknown
*/
public int getLineNumber() {
return lineNumber;
}
/**
* Column number of the location of the error
*
* @return the column number or -1 if unknown
*/
public int getColumnNumber() {
return columnNumber;
}
@Override
public RestStatus status() {
return RestStatus.BAD_REQUEST;
}
@Override
protected void metadataToXContent(XContentBuilder builder, Params params) throws IOException {
if (lineNumber != UNKNOWN_POSITION) {
builder.field("line", lineNumber);
builder.field("col", columnNumber);
}
}
@Override
protected void writeTo(StreamOutput out, Writer nestedExceptionsWriter) throws IOException {
super.writeTo(out, nestedExceptionsWriter);
out.writeInt(lineNumber);
out.writeInt(columnNumber);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy