001/*
002 The contents of this file are subject to the Mozilla Public License Version 1.1
003 (the "License"); you may not use this file except in compliance with the License.
004 You may obtain a copy of the License at http://www.mozilla.org/MPL/
005 Software distributed under the License is distributed on an "AS IS" basis,
006 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
007 specific language governing rights and limitations under the License.
008
009 The Original Code is "ValidatingMessageVisitor.java".  Description:
010 "Base class for visitors that run over a message and thereby collect ValidationExceptions"
011
012 The Initial Developer of the Original Code is University Health Network. Copyright (C)
013 2013.  All Rights Reserved.
014
015 Contributor(s): ______________________________________.
016
017 Alternatively, the contents of this file may be used under the terms of the
018 GNU General Public License (the "GPL"), in which case the provisions of the GPL are
019 applicable instead of those above.  If you wish to allow use of your version of this
020 file only under the terms of the GPL and not to allow others to use your version
021 of this file under the MPL, indicate your decision by deleting  the provisions above
022 and replace  them with the notice and other provisions required by the GPL License.
023 If you do not delete the provisions above, a recipient may use your version of
024 this file under either the MPL or the GPL.
025 */
026
027package ca.uhn.hl7v2.validation.builder.support;
028
029import java.util.ArrayList;
030import java.util.Arrays;
031import java.util.List;
032
033import ca.uhn.hl7v2.model.MessageVisitorSupport;
034import ca.uhn.hl7v2.validation.ValidationException;
035
036/**
037 * Base class for visitors that run over a message and thereby collect {@link ValidationException}s.
038 * Concrete implementations must override the visitor methods and provide a corresponding
039 * {@link ca.uhn.hl7v2.model.MessageVisitorFactory MessageVisitorFactory} implementation that
040 * instantiates objects of this type.
041 */
042public abstract class ValidatingMessageVisitor extends MessageVisitorSupport {
043
044    private List<ValidationException> validationExceptions = new ArrayList<ValidationException>();
045
046    protected boolean addValidationException(ValidationException e) {
047        return (e != null) && validationExceptions.add(e);
048    }
049
050    protected boolean addValidationExceptions(ValidationException... e) {
051        return (e != null) && validationExceptions.addAll(Arrays.asList(e));
052    }
053
054    ValidationException[] getValidationExceptions() {
055        return validationExceptions.toArray(new ValidationException[validationExceptions.size()]);
056    }
057
058}