com.speedment.runtime.compute.trait.HasHash Maven / Gradle / Ivy

Go to download
/*
 *
 * Copyright (c) 2006-2020, Speedment, Inc. 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 com.speedment.runtime.compute.trait;

/**
 * Trait for expressions that has a hash algorithm implemented for the type that
 * it results in.
 *
 * @author Emil Forslund
 * @since  3.1.0
 */
public interface HasHash {

    /**
     * Hash the specified object into a 64-bit hash. If two equal objects are
     * hashed, they must always result in the same hash. However, objects that
     * are not equal may also result in the same hash.
     *
     * @param object  the object to hash
     * @return        the 64-bit hashcode
     */
    long hash(T object);

}