org.apache.jackrabbit.oak.cache.EmpiricalWeigher Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.jackrabbit.oak.cache;

import org.apache.jackrabbit.guava.common.cache.Weigher;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 *  Determines the weight of object based on the memory taken by them. The memory estimates
 *  are based on empirical data and not exact
 *
 * @deprecated The Jackrabbit Oak Cache library is designed for Oak-internal use only and thus deprecated. It will not be part of the AEM SDK after April 2023.
 */
@Deprecated(since = "2022-12-01")
public class EmpiricalWeigher implements Weigher {

    static final Logger LOG = LoggerFactory.getLogger(EmpiricalWeigher.class);

    @Override
    public int weigh(CacheValue key, CacheValue value) {
        // overhead for each cache entry
        long size = 168;
        // key
        size += key.getMemory();
        // value
        size += value.getMemory();
        if (size > Integer.MAX_VALUE) {
            LOG.debug("Calculated weight larger than Integer.MAX_VALUE: {}.", size);
            size = Integer.MAX_VALUE;
        }
        return (int) size;
    }
}