Partitioner.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 io.jafka.producer;

/**
 * some messages to special broker(server)
 * 
 * @author adyliu (imxylz@gmail.com)
 * @since 1.0
 */
public interface Partitioner<T> {

    /**
     * Uses the key to calculate a partition bucket id for routing the data to the appropriate
     * broker partition
     * @param key key of partition name
     * @param numPartitions number of paritition
     * @return an integer between 0 and numPartitions-1
     */
    int partition(T key, int numPartitions);
}