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;
018
019/**
020 * Generates markup ids for components
021 */
022@FunctionalInterface
023public interface IMarkupIdGenerator
024{
025        /**
026         * Generates markup id for the given component
027         *
028         * @param component
029         *            The component for which to generate a markup id
030         * @param createIfDoesNotExist
031         *            When there is no existing markup id, determines whether it should be generated or
032         *            whether <code>null</code> should be returned.
033         * @return The generated markup id
034         */
035        String generateMarkupId(Component component, boolean createIfDoesNotExist);
036}