scr-annotations/src/main/java/org/apache/felix/scr/annotations/ConfigurationPolicy.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.felix.scr.annotations;

/**
 * Options for {@link Component#policy()} property.
 */
public enum ConfigurationPolicy {

    /**
     * If a configuration is available it will be used, if not the component
     * will be activated anyway (this is the default).
     */
    OPTIONAL,

    /**
     * The configuration admin is not consulted for a configuration for this component.
     */
    IGNORE,

    /**
     * In order to activate this component a configuration is required.
     */
    REQUIRE;

    /**
     * @return String representation of policy
     */
    public String getPolicyString() {
        return this.name().toLowerCase();
    }

}