/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.daffodil.api.validation;

import org.apache.daffodil.validation.XercesValidator;

import java.io.InputStream;
import java.io.Serializable;

/**
 * Implement this trait to provide custom validation logic
 * <p>
 * The Validator implementations must be thread safe
 *
 * @see XercesValidator for example of using ThreadLocal for thread safety
 * <p>
 * Validation errors should be reported by calling the appropriate functions on the
 * ValidationHandler
 */
public interface Validator extends Serializable {

  /**
   * Used to validate XMLs. Any validation diagnostics will be added to the state
   *
   * @param document Inputstream containing xml to be validated
   * @param handler  validation handler used to handle errors. Mutates state.
   */
  void validateXML(InputStream document, ValidationHandler handler);
}
