MemoryPolicy.java

/*
 * 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.ignite.internal.processors.cache.database;

import org.apache.ignite.configuration.MemoryPolicyConfiguration;
import org.apache.ignite.internal.pagemem.PageMemory;
import org.apache.ignite.internal.processors.cache.database.evict.PageEvictionTracker;

/**
 * Memory policy provides access to objects configured with {@link MemoryPolicyConfiguration} configuration.
 */
public class MemoryPolicy {
    /** */
    private final PageMemory pageMem;

    /** */
    private final MemoryMetricsImpl memMetrics;

    /** */
    private final MemoryPolicyConfiguration cfg;

    /** */
    private final PageEvictionTracker evictionTracker;

    /**
     * @param pageMem PageMemory instance.
     * @param memMetrics MemoryMetrics instance.
     * @param cfg Configuration of given MemoryPolicy.
     * @param evictionTracker Eviction tracker.
     */
    public MemoryPolicy(
        PageMemory pageMem,
        MemoryPolicyConfiguration cfg,
        MemoryMetricsImpl memMetrics,
        PageEvictionTracker evictionTracker) {
        this.pageMem = pageMem;
        this.memMetrics = memMetrics;
        this.cfg = cfg;
        this.evictionTracker = evictionTracker;
    }

    /**
     *
     */
    public PageMemory pageMemory() {
        return pageMem;
    }

    /**
     * @return Config.
     */
    public MemoryPolicyConfiguration config() {
        return cfg;
    }

    /**
     * @return Memory Metrics.
     */
    public MemoryMetricsImpl memoryMetrics() {
        return memMetrics;
    }

    /**
     *
     */
    public PageEvictionTracker evictionTracker() {
        return evictionTracker;
    }
}