001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Portions Copyright 2010-2024 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.internal;
028
029
030
031import java.util.List;
032import java.util.Map;
033
034import com.unboundid.util.NotExtensible;
035import com.unboundid.util.ThreadSafety;
036import com.unboundid.util.ThreadSafetyLevel;
037
038
039
040/**
041 * This interface is used to mark extensions which may provide examples that
042 * demonstrate how they are intended to be used.
043 */
044@NotExtensible()
045@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
046public interface ExampleUsageProvider
047       extends Configurable
048{
049  /**
050   * Retrieves a map containing examples of configurations that may be used for
051   * this extension.  The map key should be a list of sample arguments, and the
052   * corresponding value should be a description of the behavior that will be
053   * exhibited by the extension when used with that configuration.
054   *
055   * @return  A map containing examples of configurations that may be used for
056   *          this extension.  It may be {@code null} or empty if there should
057   *          not be any example argument sets.
058   */
059  Map<List<String>,String> getExamplesArgumentSets();
060}