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 2008 Sun Microsystems, Inc.
015 * Portions Copyright 2016 ForgeRock AS.
016 */
017
018package org.forgerock.opendj.config;
019
020/** This enumeration contains various options that can be associated with property definitions. */
021public enum PropertyOption {
022    /**
023     * Use this option to identify properties which should be considered as
024     * advanced and should not be exposed by default in client applications.
025     */
026    ADVANCED,
027
028    /**
029     * Use this option to identify properties which must not be directly exposed
030     * in client applications.
031     */
032    HIDDEN,
033
034    /** Use this option to identify properties which must have a value. */
035    MANDATORY,
036
037    /** Use this option to identify properties which are multi-valued. */
038    MULTI_VALUED,
039
040    /**
041     * Use this option to identify properties which can be initialized once only
042     * and are read-only thereafter.
043     */
044    READ_ONLY,
045
046    /**
047     * Use this option to identify properties which are for monitoring purposes
048     * only and are generated automatically by the server..
049     */
050    MONITORING;
051}