org.kie.api.conf.KieBaseMutabilityOption Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed 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.kie.api.conf;


/**
 * An option to define if a KieBase should be mutable or not.
 * By default mutability (incremental compilation) is allowed but for performances reasonds
 * it is strongly recommended to set this option to "disabled" if you don't need it.
 *
 * drools.kieBaseMutability = <allowed|disabled>
 *
 * DEFAULT = allowed
 */
public enum KieBaseMutabilityOption implements SingleValueKieBaseOption {

    ALLOWED,
    DISABLED;

    /**
     * The property name for the sequential mode option
     */
    public static final String PROPERTY_NAME = "drools.kieBaseMutability";

    public static OptionKey KEY = new OptionKey(TYPE, PROPERTY_NAME);

    /**
     * {@inheritDoc}
     */
    public String getPropertyName() {
        return PROPERTY_NAME;
    }

    public static KieBaseMutabilityOption determineMutability( String option ) {
        if ( ALLOWED.name().equalsIgnoreCase(option) ) {
            return ALLOWED;
        } else if ( DISABLED.name().equalsIgnoreCase( option ) ) {
            return DISABLED;
        }
        throw new IllegalArgumentException( "Illegal enum value '" + option + "' for KieBaseMutabilityOption" );
    }

    public boolean isMutabilityEnabled() {
        return this == ALLOWED;
    }
}