All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jomc.modlet.ModelProvider Maven / Gradle / Ivy

/*
 *   Copyright (C) Christian Schulte, 2005-206
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     o Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *     o Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *
 *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *   $JOMC: ModelProvider.java 4613 2012-09-22 10:07:08Z schulte $
 *
 */
package org.jomc.modlet;

/**
 * {@code Model} provider interface.
 *
 * @author Christian Schulte
 * @version $JOMC: ModelProvider.java 4613 2012-09-22 10:07:08Z schulte $
 * @see ModelContext#findModel(java.lang.String)
 */
public interface ModelProvider
{

    /**
     * Searches a given context for a {@code Model}.
     *
     * @param context The context to search for a {@code Model}.
     * @param model The {@code Model} currently being searched.
     *
     * @return The {@code Model} found in the context or {@code null}, if no {@code Model} is found.
     *
     * @throws NullPointerException if {@code context} or {@code model} is {@code null}.
     * @throws ModelException if searching the context fails.
     */
    Model findModel( ModelContext context, Model model ) throws NullPointerException, ModelException;

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy