001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.markup.resolver;
018
019import org.apache.wicket.Component;
020import org.apache.wicket.MarkupContainer;
021import org.apache.wicket.markup.ComponentTag;
022import org.apache.wicket.markup.MarkupStream;
023import org.apache.wicket.settings.PageSettings;
024import org.apache.wicket.util.io.IClusterable;
025
026/**
027 * IComponentResolvers are responsible for mapping component names to Wicket components. Resolvers
028 * are first looked up in a component's hierarchy before falling back to a list of
029 * IComponentResolvers maintained in {@link PageSettings}.
030 * 
031 * NOTE: implementations for this interface must be thread-safe!
032 * 
033 * @see ComponentResolvers
034 * 
035 * @author Juergen Donnerstag
036 */
037public interface IComponentResolver extends IClusterable
038{
039        /**
040         * Try to resolve a component.
041         * 
042         * @param container
043         *            The container parsing its markup
044         * @param markupStream
045         *            The current markupStream
046         * @param tag
047         *            The current component tag while parsing the markup
048         * @return component or {@code null} if not found
049         */
050        Component resolve(final MarkupContainer container, final MarkupStream markupStream,
051                final ComponentTag tag);
052}