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