Package ca.uhn.fhir.parser

Class LenientErrorHandler

java.lang.Object

ca.uhn.fhir.parser.LenientErrorHandler

All Implemented Interfaces:

IParserErrorHandler

public class LenientErrorHandler
extends Object
implements IParserErrorHandler

The default error handler, which logs issues but does not abort parsing, with only two exceptions:

The invalidValue(ca.uhn.fhir.parser.IParserErrorHandler.IParseLocation, java.lang.String, java.lang.String) method will throw a DataFormatException by default since ignoring this type of error can lead to data loss (since invalid values are silently ignored). See setErrorOnInvalidValue(boolean) for information on this.

The extensionContainsValueAndNestedExtensions(ca.uhn.fhir.parser.IParserErrorHandler.IParseLocation) method will throw a DataFormatException by default since ignoring this type of error will allow malformed resouces to be created and result in errors when attempts to read, update or delete the resource in the future. See setErrorOnInvalidExtension(boolean) for information on this.

See Also:

• IParser.setParserErrorHandler(IParserErrorHandler)
• FhirContext.setParserErrorHandler(IParserErrorHandler)

Nested Class Summary

Nested classes/interfaces inherited from interface ca.uhn.fhir.parser.IParserErrorHandler

IParserErrorHandler.IParseLocation

Constructor Summary

Constructors

Constructor	Description
LenientErrorHandler()	Constructor which configures this handler to log all errors
LenientErrorHandler(boolean theLogErrors)	Constructor

Method Summary

Modifier and Type	Method	Description
void	containedResourceWithNoId(IParserErrorHandler.IParseLocation theLocation)	Invoked when a contained resource is parsed that has no ID specified (and is therefore invalid)
static String	createIncorrectJsonTypeMessage(String theElementName, BaseJsonLikeValue.ValueType theExpected, BaseJsonLikeValue.ScalarType theExpectedScalarType, BaseJsonLikeValue.ValueType theFound, BaseJsonLikeValue.ScalarType theFoundScalarType)
LenientErrorHandler	disableAllErrors()	If this method is called, both invalid resource extensions and invalid attribute values will set to simply logging errors.
void	extensionContainsValueAndNestedExtensions(IParserErrorHandler.IParseLocation theLocation)	An extension contains both a value and at least one nested extension
void	incorrectJsonType(IParserErrorHandler.IParseLocation theLocation, String theElementName, BaseJsonLikeValue.ValueType theExpected, BaseJsonLikeValue.ScalarType theExpectedScalarType, BaseJsonLikeValue.ValueType theFound, BaseJsonLikeValue.ScalarType theFoundScalarType)	Invoked if the wrong type of element is found while parsing JSON.
void	invalidInternalReference(IParserErrorHandler.IParseLocation theLocation, String theReference)	Contained resource has an invalid internal reference.
void	invalidValue(IParserErrorHandler.IParseLocation theLocation, String theValue, String theError)	The parser detected an attribute value that was invalid (such as: empty "" values are not permitted)
boolean	isErrorOnInvalidExtension()	If set to false (default is true) invalid extensions will be logged.
boolean	isErrorOnInvalidValue()	If set to false (default is true) invalid values will be logged.
void	missingRequiredElement(IParserErrorHandler.IParseLocation theLocation, String theElementName)	Resource was missing a required element
LenientErrorHandler	setErrorOnInvalidExtension(boolean theErrorOnInvalidExtension)	If set to false (default is true) invalid extensions will be logged.
LenientErrorHandler	setErrorOnInvalidValue(boolean theErrorOnInvalidValue)	If set to false (default is true) invalid values will be logged.
void	unexpectedRepeatingElement(IParserErrorHandler.IParseLocation theLocation, String theElementName)	Invoked when an element repetition (e.g. a second repetition of something) is found for a field which is non-repeating.
void	unknownAttribute(IParserErrorHandler.IParseLocation theLocation, String theElementName)	Invoked when an unknown element is found in the document.
void	unknownElement(IParserErrorHandler.IParseLocation theLocation, String theElementName)	Invoked when an unknown element is found in the document.
void	unknownReference(IParserErrorHandler.IParseLocation theLocation, String theReference)	Resource contained a reference that could not be resolved and needs to be resolvable (e.g. because it is a local reference to an unknown contained resource)

Methods inherited from class java.lang.Object

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

Constructor Details

LenientErrorHandler

public LenientErrorHandler()

Constructor which configures this handler to log all errors

LenientErrorHandler

public LenientErrorHandler(boolean theLogErrors)

Constructor

Parameters:

theLogErrors - Should errors be logged?

Since:

1.2

Method Details

containedResourceWithNoId

public void containedResourceWithNoId(IParserErrorHandler.IParseLocation theLocation)

Description copied from interface: IParserErrorHandler

Invoked when a contained resource is parsed that has no ID specified (and is therefore invalid)

Specified by:

containedResourceWithNoId in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. WILL ALWAYS BE NULL currently, as this is not yet implemented, but this parameter is included so that locations can be added in the future without changing the API.

incorrectJsonType

public void incorrectJsonType(IParserErrorHandler.IParseLocation theLocation,
 String theElementName,
 BaseJsonLikeValue.ValueType theExpected,
 BaseJsonLikeValue.ScalarType theExpectedScalarType,
 BaseJsonLikeValue.ValueType theFound,
 BaseJsonLikeValue.ScalarType theFoundScalarType)

Description copied from interface: IParserErrorHandler

Invoked if the wrong type of element is found while parsing JSON. For example if a given element is expected to be a JSON Object and is a JSON array

Specified by:

incorrectJsonType in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theElementName - The name of the element that was found.

theExpected - The datatype that was expected at this location

theExpectedScalarType - If theExpectedValueType is BaseJsonLikeValue.ValueType.SCALAR, this is the specific scalar type expected. Otherwise this parameter will be null.

theFound - The datatype that was found at this location

theFoundScalarType - If theFoundValueType is BaseJsonLikeValue.ValueType.SCALAR, this is the specific scalar type found. Otherwise this parameter will be null.

invalidValue

public void invalidValue(IParserErrorHandler.IParseLocation theLocation,
 String theValue,
 String theError)

Description copied from interface: IParserErrorHandler

The parser detected an attribute value that was invalid (such as: empty "" values are not permitted)

Specified by:

invalidValue in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theValue - The actual value

theError - A description of why the value was invalid

isErrorOnInvalidValue

public boolean isErrorOnInvalidValue()

If set to false (default is true) invalid values will be logged. By default, invalid attribute values cause this error handler to throw a DataFormatException (unlike other methods in this class which default to simply logging errors).

Note that empty values (e.g. "") will not lead to an error when this is set to true, only invalid values (e.g. a gender code of foo)

See Also:

• setErrorOnInvalidValue(boolean)

isErrorOnInvalidExtension

public boolean isErrorOnInvalidExtension()

If set to false (default is true) invalid extensions will be logged. By default, invalid resource extensions cause this error handler to throw a DataFormatException (unlike other methods in this class which default to simply logging errors).

See Also:

• setErrorOnInvalidExtension(boolean)

missingRequiredElement

public void missingRequiredElement(IParserErrorHandler.IParseLocation theLocation,
 String theElementName)

Description copied from interface: IParserErrorHandler

Resource was missing a required element

Specified by:

missingRequiredElement in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theElementName - The missing element name

setErrorOnInvalidValue

public LenientErrorHandler setErrorOnInvalidValue(boolean theErrorOnInvalidValue)

If set to false (default is true) invalid values will be logged. By default, invalid attribute values cause this error handler to throw a DataFormatException (unlike other methods in this class which default to simply logging errors).

Note that empty values (e.g. "") will not lead to an error when this is set to true, only invalid values (e.g. a gender code of foo)

Returns:

Returns a reference to this for easy method chaining

See Also:

• isErrorOnInvalidValue()

setErrorOnInvalidExtension

public LenientErrorHandler setErrorOnInvalidExtension(boolean theErrorOnInvalidExtension)

If set to false (default is true) invalid extensions will be logged. By default, invalid resource extensions cause this error handler to throw a DataFormatException (unlike other methods in this class which default to simply logging errors).

Returns:

Returns a reference to this for easy method chaining

See Also:

• isErrorOnInvalidExtension()

disableAllErrors

public LenientErrorHandler disableAllErrors()

If this method is called, both invalid resource extensions and invalid attribute values will set to simply logging errors.

unexpectedRepeatingElement

public void unexpectedRepeatingElement(IParserErrorHandler.IParseLocation theLocation,
 String theElementName)

Description copied from interface: IParserErrorHandler

Invoked when an element repetition (e.g. a second repetition of something) is found for a field which is non-repeating.

Specified by:

unexpectedRepeatingElement in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theElementName - The name of the element that was found.

unknownAttribute

public void unknownAttribute(IParserErrorHandler.IParseLocation theLocation,
 String theElementName)

Description copied from interface: IParserErrorHandler

Invoked when an unknown element is found in the document.

Specified by:

unknownAttribute in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theElementName - The name of the attribute that was found.

unknownElement

public void unknownElement(IParserErrorHandler.IParseLocation theLocation,
 String theElementName)

Description copied from interface: IParserErrorHandler

Invoked when an unknown element is found in the document.

Specified by:

unknownElement in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theElementName - The name of the element that was found.

unknownReference

public void unknownReference(IParserErrorHandler.IParseLocation theLocation,
 String theReference)

Description copied from interface: IParserErrorHandler

Resource contained a reference that could not be resolved and needs to be resolvable (e.g. because it is a local reference to an unknown contained resource)

Specified by:

unknownReference in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theReference - The actual invalid reference (e.g. "#3")

invalidInternalReference

public void invalidInternalReference(IParserErrorHandler.IParseLocation theLocation,
 String theReference)

Description copied from interface: IParserErrorHandler

Contained resource has an invalid internal reference. A contained reference starts with an octothrope (#) but there are no contained resources with this given id.

Specified by:

invalidInternalReference in interface IParserErrorHandler

Parameters:

theLocation - The location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

theReference - The string reference ('#123')

extensionContainsValueAndNestedExtensions

public void extensionContainsValueAndNestedExtensions(IParserErrorHandler.IParseLocation theLocation)

Description copied from interface: IParserErrorHandler

An extension contains both a value and at least one nested extension

Specified by:

extensionContainsValueAndNestedExtensions in interface IParserErrorHandler

Parameters:

theLocation - location in the document. Note that this may be null as the ParseLocation feature is experimental. Use with caution, as the API may change.

createIncorrectJsonTypeMessage

public static String createIncorrectJsonTypeMessage(String theElementName,
 BaseJsonLikeValue.ValueType theExpected,
 BaseJsonLikeValue.ScalarType theExpectedScalarType,
 BaseJsonLikeValue.ValueType theFound,
 BaseJsonLikeValue.ScalarType theFoundScalarType)