fiftyone.pipeline.engines.configuration.CacheConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pipeline.engines Show documentation

Shared base functionality for implementing engines for the 51Degrees Pipeline API

There is a newer version: 4.4.61

/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
 *
 * This Original Work is licensed under the European Union Public Licence
 * (EUPL) v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 *
 * If using the Work as, or as part of, a network application, by
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading,
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

package fiftyone.pipeline.engines.configuration;

import fiftyone.caching.CacheBuilder;
import fiftyone.caching.LruPutCache;

/**
 * Contains everything needed to build a cache.
 * Currently, a {@link CacheBuilder} and an integer size parameter.
 * @see Specification
 */
public class CacheConfiguration {

    public static final int defaultSize = 1000;

    private final CacheBuilder builder;

    private final int size;

    /**
     * Construct a new builder with the builder and size specified.
     * @param builder the builder to use to create caches
     * @param size the maximum size of the cache
     */
    public CacheConfiguration(CacheBuilder builder, int size) {
        this.builder = builder;
        this.size = size;
    }

    /**
     * Construct a new builder using the {@link LruPutCache} with the size
     * specified.
     * @param size maximum size of the cache
     */
    public CacheConfiguration(int size) {
        this(new LruPutCache.Builder(), size);
    }

    /**
     * Default constructor uses the {@link LruPutCache} with a size of 1000.
     */
    public CacheConfiguration() {
        this(new LruPutCache.Builder(), defaultSize);
    }

    /**
     * Get the builder to use when building a cache.
     * @return cache builder
     */
    public CacheBuilder getCacheBuilder() {
        return builder;
    }

    /**
     * Get the maximum size parameter to use when building a cache.
     * @return cache size
     */
    public int getSize() {
        return size;
    }
}