Github user mcvsubbu commented on a diff in the pull request:
https://github.com/apache/helix/pull/145#discussion_r174525270
--- Diff:
helix-core/src/main/java/org/apache/helix/api/rebalancer/constraint/dataprovider/CapacityProvider.java
---
@@ -0,0 +1,38 @@
+package org.apache.helix.api.rebalancer.constraint.dataprovider;
+
+/*
+ * 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.
+ */
+
+/**
+ * An interface for getting participant capacity information.
+ */
+public interface CapacityProvider {
+
+ /**
+ * @param participant
+ * @return The total participant capacity.
+ */
+ int getParticipantCapacity(String participant);
+
+ /**
+ * @param participant
+ * @return The provisioned capacity.
+ */
+ int getParticipantProvisioned(String participant);
--- End diff --
Please provide examples in the javadoc. In this case, I would add something
like: "For example if the constraint is on memory used by a resource in a
participant, and the participant is provisioned with a max of 10MB for
resources, out of which 40k is used, the getParticpantUsage() should return 40,
and getParticipantCapacity() should return 100000. On the other hand, if the
constraint is on number of partitions in a participant, and the particpant has
been provisioned to for a max of 1200 partitions, but has only 65, then
getParticipantUsage() should return 65, and getParticipantCapacity() should
return 1200" -- something like this. It does not hurt to have more comments.
You will get less questions.
---
