org.xwiki.rendering.macro.toc.TocTreeBuilderFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-macro-toc Show documentation

Generates a Table Of Content for titles (headings)

There is a newer version: 16.8.0-rc-1

Show newest version

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.macro.toc;

import org.xwiki.component.annotation.Role;
import org.xwiki.component.manager.ComponentLookupException;
import org.xwiki.rendering.internal.macro.toc.TocTreeBuilder;
import org.xwiki.stability.Unstable;

/**
 * Provide the operations to build a {@link TocTreeBuilder}, possibly based on a hint used to select the heading
 * resolver.
 *
 * @version $Id: 388a094a6573b2dfe47df479652270291414d5d7 $
 * @since 15.8RC1
 */
@Role
@Unstable
public interface TocTreeBuilderFactory
{
    /**
     * @return a toc tree builder using the default {@link TocEntriesResolver}
     * @throws ComponentLookupException in case of error when accessing the {@link TocEntriesResolver} or
     *     {@link TocEntryExtension} instances
     */
    default TocTreeBuilder build() throws ComponentLookupException
    {
        return build(null);
    }

    /**
     * @param resolverHint the hint to use to resolve the {@link TocEntriesResolver}
     * @return a toc tree builder using the a {@link TocEntriesResolver} with hint {@code resolverHint}
     * @throws ComponentLookupException in case of error when accessing the {@link TocEntriesResolver} or
     *     {@link TocEntryExtension} instances
     */
    TocTreeBuilder build(String resolverHint) throws ComponentLookupException;
}