001/*
002 * Copyright 2019 Leibniz-Institut für Analytische Wissenschaften – ISAS – e.V..
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.isas.mztab2.io.validators;
017
018import java.util.Collections;
019import java.util.List;
020import uk.ac.ebi.pride.jmztab2.utils.errors.MZTabError;
021import uk.ac.ebi.pride.jmztab2.utils.parser.MZTabParserContext;
022
023/**
024 * Implementations of the parsing validator are applied to the type object
025 * during the parsing process.
026 *
027 * @author nilshoffmann
028 * @param <T> the type of the parsed object to validate.
029 */
030public interface MetadataValidator<T> {
031
032    /**
033     * Validate the given object of type T, using the provided parser context to
034     * check state of not yet completely parsed and constructed mzTab hierarchy.
035     *
036     * @param t the object to validate
037     * @param parserContext the parser context
038     * @return a list of {@link MZTabError}, maybe empty.
039     */
040    public default List<MZTabError> validateRefine(T t, MZTabParserContext parserContext) {
041        return Collections.emptyList();
042    }
043
044}