geode-core/src/main/java/org/apache/geode/internal/cache/partitioned/InternalPartitionDetails.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.geode.internal.cache.partitioned;

import org.apache.geode.cache.partition.PartitionMemberInfo;

/**
 * Provides load and bucket level details for internal use. Extends
 * {@link org.apache.geode.cache.partition.PartitionMemberInfo}.
 *
 */
public interface InternalPartitionDetails
    extends PartitionMemberInfo, Comparable<InternalPartitionDetails> {

  /**
   * Returns the load for the partitioned region.
   *
   * @return the load for the partitioned region
   */
  PRLoad getPRLoad();

  /**
   * Returns the size of the bucket in bytes.
   *
   * @param bucketId the identity of the bucket from 0 to number of buckets -1
   * @return the size of the bucket in bytes
   */
  long getBucketSize(int bucketId);

}