001/*
002 *   Copyright (C) 2015 Christian Schulte <cs@schulte.it>
003 *   All rights reserved.
004 *
005 *   Redistribution and use in source and binary forms, with or without
006 *   modification, are permitted provided that the following conditions
007 *   are met:
008 *
009 *     o Redistributions of source code must retain the above copyright
010 *       notice, this list of conditions and the following disclaimer.
011 *
012 *     o Redistributions in binary form must reproduce the above copyright
013 *       notice, this list of conditions and the following disclaimer in
014 *       the documentation and/or other materials provided with the
015 *       distribution.
016 *
017 *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
018 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
019 *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
020 *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
021 *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
022 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
023 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
024 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
026 *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027 *
028 *   $JOMC: ModletValidator.java 5101 2016-04-04 18:52:11Z schulte $
029 *
030 */
031package org.jomc.modlet;
032
033/**
034 * {@code Modlet} validator interface.
035 *
036 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
037 * @version $JOMC: ModletValidator.java 5101 2016-04-04 18:52:11Z schulte $
038 * @see ModelContext#validateModlets(org.jomc.modlet.Modlets)
039 * @since 1.9
040 */
041public interface ModletValidator
042{
043
044    /**
045     * Gets the ordinal number of the validator.
046     *
047     * @return The ordinal number of the validator.
048     */
049    int getOrdinal();
050
051    /**
052     * Validates a given list of {@code Modlet}s with a context.
053     *
054     * @param context The context to validate {@code Modlets} with.
055     * @param modlets The {@code Modlets} to validate.
056     *
057     * @return Validation report.
058     *
059     * @throws NullPointerException if {@code context} or {@code modlets} is {@code null}.
060     * @throws ModelException if validating {@code modlets} fails.
061     *
062     * @see ModelValidationReport#isModelValid()
063     */
064    ModelValidationReport validateModlets( ModelContext context, Modlets modlets )
065        throws NullPointerException, ModelException;
066
067}