001    /*
002     *   Copyright (C) Christian Schulte, 2005-206
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: ModelProvider.java 3838 2011-10-08 20:15:41Z schulte2005 $
029     *
030     */
031    package org.jomc.modlet;
032    
033    /**
034     * {@code Model} provider interface.
035     *
036     * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a>
037     * @version $JOMC: ModelProvider.java 3838 2011-10-08 20:15:41Z schulte2005 $
038     * @see ModelContext#findModel(java.lang.String)
039     */
040    public interface ModelProvider
041    {
042    
043        /**
044         * Searches a given context for a {@code Model}.
045         *
046         * @param context The context to search for a {@code Model}.
047         * @param model The {@code Model} currently being searched.
048         *
049         * @return The {@code Model} found in the context or {@code null}, if no {@code Model} is found.
050         *
051         * @throws NullPointerException if {@code context} or {@code model} is {@code null}.
052         * @throws ModelException if searching the context fails.
053         */
054        Model findModel( ModelContext context, Model model ) throws NullPointerException, ModelException;
055    
056    }