org.jooq.CacheContext Maven / Gradle / Ivy

Go to download

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

There is a newer version: 3.19.18

/*
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jooq.impl.CacheType;

/**
 * The parameter object passed to the
 * {@link CacheProvider#provide(CacheContext)} method.
 * 
 * This {@link Scope} is very short lived, for the duration of a cache
 * implementation lookup of one of the various internal {@link CacheType}
 * caches.
 * 
 * It does not live in the context of a parent {@link Scope}, and as such, does
 * not have access to any {@link #data()} from another {@link Scope}.
 *
 * @author Lukas Eder
 */
public interface CacheContext extends Scope {

    /**
     * The cache type for which a cache should be provided.
     */
    CacheType cacheType();
}