ca.uhn.hl7v2.parser.UnexpectedSegmentBehaviourEnum Maven / Gradle / Ivy

package ca.uhn.hl7v2.parser;

import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.model.Message;

/**
 * Defines the behaviour to use when an unexpected
 * segment is discovered while parsing a message.
 * 
 * @see ParserConfiguration#setUnexpectedSegmentBehaviour(UnexpectedSegmentBehaviourEnum)
 */
public enum UnexpectedSegmentBehaviourEnum {

	/**
	 * 
	 * Add the segment as a 
	 * {@link Message#addNonstandardSegment(String) nonstandard segment}
	 * at the current location, even if the current location is in a 
	 * child group within the message.
	 * 
	 * 
	 * This is the default.
	 * 
	 */
	ADD_INLINE,

	/**
	 * Return the parser back to the root of the message (even if the last
	 * segment was in a group) and add the unexpected segment as a
	 * {@link Message#addNonstandardSegment(String) nonstandard segment}.
	 */
	DROP_TO_ROOT,

	/**
	 * Throw an {@link HL7Exception}
	 */
	THROW_HL7_EXCEPTION
}