com.arangodb.entity.arangosearch.PrimarySort Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver-shaded Show documentation

ArangoDB Java Driver Shaded

There is a newer version: 7.20.0

Show newest version

/*
 * DISCLAIMER
 *
 * Copyright 2019 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.entity.arangosearch;

import com.arangodb.shaded.fasterxml.jackson.annotation.JsonIgnore;
import com.arangodb.shaded.fasterxml.jackson.annotation.JsonProperty;

import java.util.Objects;

/**
 * @author Heiko Kernbach
 */
public final class PrimarySort {

    private final String fieldName;
    private Boolean ascending;

    public PrimarySort(
            @JsonProperty("field") String field,
            @JsonProperty("asc") Boolean asc
    ) {
        this.fieldName = field;
        this.ascending = asc;
    }

    private PrimarySort(final String fieldName) {
        super();
        this.fieldName = fieldName;
    }

    public static PrimarySort on(final String fieldName) {
        return new PrimarySort(fieldName);
    }

    /**
     * @param ascending
     * @return primarySort
     */
    public PrimarySort ascending(final Boolean ascending) {
        this.ascending = ascending;
        return this;
    }

    @JsonIgnore
    public Boolean getAscending() {
        return ascending;
    }

    public Direction getDirection() {
        if (ascending == null) {
            return null;
        }
        return ascending ? Direction.asc : Direction.desc;
    }

    /**
     * @deprecated for removal, use {@link #getField()} instead
     */
    @Deprecated
    @JsonIgnore
    public String getFieldName() {
        return getField();
    }

    public String getField() {
        return fieldName;
    }

    public enum Direction {
        asc,
        desc
    }

    @Override
    public boolean equals(Object o) {
        if (!(o instanceof PrimarySort)) return false;
        PrimarySort that = (PrimarySort) o;
        return Objects.equals(fieldName, that.fieldName) && Objects.equals(ascending, that.ascending);
    }

    @Override
    public int hashCode() {
        return Objects.hash(fieldName, ascending);
    }
}