com.landawn.abacus.jdbc.annotation.CacheResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-jdbc Show documentation
abacus jdbc
There is a newer version: 3.8.5
/*
 * Copyright (c) 2021, Haiyang Li.
 *
 * 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 com.landawn.abacus.jdbc.annotation;

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

import com.landawn.abacus.annotation.Beta;

@Beta
@Retention(RetentionPolicy.RUNTIME)
@Target(value = { ElementType.METHOD, ElementType.TYPE })
public @interface CacheResult {
    /**
     * Flag to identity if {@code CacheResult} is disabled.
     * @return
     */
    boolean disabled() default false;

    /**
     *
     * @return
     */
    long liveTime() default 30 * 60 * 1000; // unit milliseconds.

    /**
     *
     * @return
     */
    long idleTime() default 3 * 60 * 1000; // unit milliseconds.

    /**
     * Minimum required size to cache query result if the return type is {@code Collection} or {@code DataSet}.
     * This setting will be ignore if the return types are not {@code Collection} or {@code DataSet}.
     *
     * @return
     */
    int minSize() default 0; // for list/DataSet.

    /**
     * If the query result won't be cached if it's size is bigger than {@code maxSize} if the return type is {@code Collection} or {@code DataSet}.
     * This setting will be ignore if the return types are not {@code Collection} or {@code DataSet}.
     *
     * @return
     */
    int maxSize() default Integer.MAX_VALUE; // for list/DataSet.

    /**
     * It's used to copy/clone the result when save result to cache or fetch result from cache.
     * It can be set to {@code "none" and "kryo"}.
     *
     * @return
     * @see https://github.com/EsotericSoftware/kryo
     */
    String transfer() default "none";

    //    /**
    //     * If it's set to true, the cached result won't be removed by method annotated by {@code RefershCache}.
    //     *
    //     * @return
    //     */
    //    boolean isStaticData() default false;

    /**
     * Those conditions(by contains ignore case or regular expression match) will be joined by {@code OR}, not {@code AND}.
     * It's only applied if target of annotation {@code RefreshCache} is {@code Type}, and will be ignored if target is method.
     *
     * @return
     */
    String[] filter() default { "query", "queryFor", "list", "get", "find", "findFirst", "findOnlyOne", "exist", "notExist", "count" };

    // TODO: second, what will key be like?: {methodName=[args]} -> JSON or kryo?
    // KeyGenerator keyGenerator() default KeyGenerator.JSON; KeyGenerator.JSON/KRYO;
}