hub/connectors/ipojo/handler/src/main/java/org/apache/directory/server/component/handler/DirectoryProperty.java

/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing,
 *   software distributed under the License is distributed on an
 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *   KIND, either express or implied.  See the License for the
 *   specific language governing permissions and limitations
 *   under the License.
 *
 */

package org.apache.directory.server.component.handler;


import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

import javax.lang.model.type.NullType;
import javax.lang.model.type.PrimitiveType;


/**
 * DirectoryProperty property annotation.
 * Must be used after {@link DirectoryComponent} annotation !
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
@Target(
    { ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
public @interface DirectoryProperty
{

    /*
     * Set Directory Property name.
     */
    String name();


    /*
     * Is the Directory Property mandatory?
     * Default : false
     */
    boolean mandatory() default false;


    /*
     * Description of Directory Property
     * Default : empty
     */
    String description() default "";


    /*
     * Generic container type, for
     * Generic Collection Directory Properties
     */
    Class containertype() default Object.class;


    /*
     * Whether property will be immutable
     * Means only assignable at creation time.
     */
    boolean immutable() default false;

}