Package org.elasticsearch.common

Class ParsingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.elasticsearch.ElasticsearchException

org.elasticsearch.common.ParsingException

All Implemented Interfaces:

java.io.Serializable, Writeable, ToXContent, ToXContentFragment

Direct Known Subclasses:

UnknownNamedObjectException

public class ParsingException
extends ElasticsearchException

Exception that can be used when parsing queries with a given XContentParser. Can contain information about location of the error.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	UNKNOWN_POSITION

Fields inherited from class org.elasticsearch.ElasticsearchException

REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsingException(int line, int col, java.lang.String msg, java.lang.Throwable cause)	This constructor is provided for use in unit tests where a XContentParser may not be available
ParsingException(StreamInput in)
ParsingException(XContentLocation contentLocation, java.lang.String msg, java.lang.Object... args)
ParsingException(XContentLocation contentLocation, java.lang.String msg, java.lang.Throwable cause, java.lang.Object... args)

Method Summary

Modifier and Type	Method	Description
int	getColumnNumber()	Column number of the location of the error
int	getLineNumber()	Line number of the location of the error
protected void	metadataToXContent(XContentBuilder builder, ToXContent.Params params)	Renders additional per exception information into the XContent
RestStatus	status()	Returns the rest status code associated with this exception.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.ElasticsearchException

addHeader, addHeader, addMetadata, addMetadata, failureFromXContent, fromXContent, generateFailureXContent, generateThrowableXContent, getDetailedMessage, getExceptionName, getExceptionName, getHeader, getHeaderKeys, getHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, innerToXContent, isRegistered, readException, readStackTrace, setIndex, setIndex, setResources, setShard, toString, toXContent, unwrapCause, writeStackTraces

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

UNKNOWN_POSITION

protected static final int UNKNOWN_POSITION

See Also:

Constant Field Values

Constructor Detail

ParsingException

public ParsingException(XContentLocation contentLocation,
                        java.lang.String msg,
                        java.lang.Object... args)

ParsingException

public ParsingException(XContentLocation contentLocation,
                        java.lang.String msg,
                        java.lang.Throwable cause,
                        java.lang.Object... args)

ParsingException

public ParsingException(int line,
                        int col,
                        java.lang.String msg,
                        java.lang.Throwable cause)

This constructor is provided for use in unit tests where a XContentParser may not be available

ParsingException

public ParsingException(StreamInput in)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLineNumber

public int getLineNumber()

Line number of the location of the error

Returns:

the line number or -1 if unknown

getColumnNumber

public int getColumnNumber()

Column number of the location of the error

Returns:

the column number or -1 if unknown

status

public RestStatus status()

Description copied from class: ElasticsearchException

Returns the rest status code associated with this exception.

Overrides:

status in class ElasticsearchException

metadataToXContent

protected void metadataToXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Description copied from class: ElasticsearchException

Renders additional per exception information into the XContent

Overrides:

metadataToXContent in class ElasticsearchException

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ElasticsearchException

Throws:

java.io.IOException