View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *  http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package org.apache.any23.validator;
    19
    20  import java.io.OutputStream;
    21
    22  /**
    23   * Defines a serializer for validation reports.
    24   *
    25   * @author Michele Mostarda (mostarda@fbk.eu)
    26   */
    27  public interface ValidationReportSerializer {
    28
    29      /**
    30       * Serializes the validation report on the given output stream.
    31       *
    32       * @param vr
    33       *            the validation report to be serialized.
    34       * @param os
    35       *            the output stream used to produce the serialization.
    36       *
    37       * @throws SerializationException
    38       *             if there is an error serializing data
    39       */
    40      void serialize(ValidationReport vr, OutputStream os) throws SerializationException;
    41
    42  }