org.springframework.data.geo.GeoPage.java Source code

Introduction

Here is the source code for org.springframework.data.geo.GeoPage.java

Source

/*
 * Copyright 2011-2019 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.geo;

import lombok.Getter;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.Pageable;
import org.springframework.lang.Nullable;
import org.springframework.util.ObjectUtils;

/**
 * Custom {@link Page} to carry the average distance retrieved from the {@link GeoResults} the {@link GeoPage} is set up
 * from.
 *
 * @author Oliver Gierke
 * @author Thomas Darimont
 * @since 1.8
 */
public class GeoPage<T> extends PageImpl<GeoResult<T>> {

    private static final long serialVersionUID = -5655267379242128600L;

    /**
     * The average distance of the underlying results.
     */
    private final @Getter Distance averageDistance;

    /**
     * Creates a new {@link GeoPage} from the given {@link GeoResults}.
     *
     * @param content must not be {@literal null}.
     */
    public GeoPage(GeoResults<T> results) {

        super(results.getContent());

        this.averageDistance = results.getAverageDistance();
    }

    /**
     * Creates a new {@link GeoPage} from the given {@link GeoResults}, {@link Pageable} and total.
     *
     * @param results must not be {@literal null}.
     * @param pageable must not be {@literal null}.
     * @param total
     */
    public GeoPage(GeoResults<T> results, Pageable pageable, long total) {

        super(results.getContent(), pageable, total);

        this.averageDistance = results.getAverageDistance();
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.domain.PageImpl#equals(java.lang.Object)
     */
    @Override
    public boolean equals(@Nullable Object obj) {

        if (this == obj) {
            return true;
        }

        if (!(obj instanceof GeoPage)) {
            return false;
        }

        GeoPage<?> that = (GeoPage<?>) obj;

        return super.equals(obj) && ObjectUtils.nullSafeEquals(this.averageDistance, that.averageDistance);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.domain.PageImpl#hashCode()
     */
    @Override
    public int hashCode() {
        return super.hashCode() + ObjectUtils.nullSafeHashCode(this.averageDistance);
    }
}