001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 */
016package org.forgerock.opendj.ldap.schema;
017
018import java.util.List;
019import java.util.Map;
020
021/**
022 * Interface for schema elements.
023 */
024public interface SchemaElement {
025
026    /**
027     * Returns the description of this schema element, or the empty string if it does not have a description.
028     *
029     * @return The description of this schema element, or the empty string if it does not have a description.
030     */
031    String getDescription();
032
033    /**
034     * Returns an unmodifiable map containing all of the extra properties associated with this schema element.
035     *
036     * @return An unmodifiable map containing all of the extra properties associated with this schema element.
037     */
038    Map<String, List<String>> getExtraProperties();
039
040}