io.machinecode.vial.api.Spread Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2015 Brent Douglas and other contributors
* as indicated by the @author tags. All rights reserved.
*
* Licensed 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.machinecode.vial.api;
/**
* Spreads a hash code to change the distribution of keys in a hash map or set.
*
* Implementations SHOULD be serializable. If they are not the map or set they are used in will
* not be serializable.
*
* @author Brent Douglas
* @since 1.0
*/
public interface Spread {
/**
* @param h The hash code to spread.
* @return The modified hash code.
*/
int spread(int h);
}