org.compass.annotations.Lazy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of compass Show documentation

Compass Search Engine Framework

There is a newer version: 2.2.0

/*
 * Copyright 2004-2006 the original author or authors.
 *
 * 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.compass.annotations;

/**
 * Defines if a mapping is lazy or not.
 *
 * @author kimchy
 */
public enum Lazy {
    /**
     * NA. Has no affect on lazy setting and defaults to the global setting.
     *
     * @see org.compass.core.config.CompassEnvironment.Osem#LAZY_REFERNCE
     */
    NA,
    /**
     * This reference mapping (only in case of collection) will be lazy.
     */
    TRUE,
    /**
     * This reference mapping (only in case of collection) will not be lazy.
     */
    FALSE
}