All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.box.sdk.SortParameters Maven / Gradle / Ivy

There is a newer version: 4.11.1
Show newest version
package com.box.sdk;

import static com.box.sdk.BoxFolder.SortDirection.ASC;
import static com.box.sdk.BoxFolder.SortDirection.DESC;

/**
 * Represents sorting parameters.
 */
public final class SortParameters {
    private static final SortParameters NONE = new SortParameters(null, null);
    private final String fieldName;
    private final BoxFolder.SortDirection sortDirection;

    /**
     * Creates sorting parameters.
     *
     * @param fieldName     Name of the field used to sort.
     * @param sortDirection Direction of the sort.
     */
    private SortParameters(String fieldName, BoxFolder.SortDirection sortDirection) {
        this.fieldName = fieldName;
        this.sortDirection = sortDirection;
    }

    /**
     * Creates ascending sorting by specified field name.
     *
     * @param fieldName Name of the field used to sort.
     * @return Sort parameters.
     */
    public static SortParameters ascending(String fieldName) {
        return new SortParameters(fieldName, ASC);
    }

    /**
     * Creates descending sorting by specified field name.
     *
     * @param fieldName Name of the field used to sort.
     * @return Sort parameters.
     */
    public static SortParameters descending(String fieldName) {
        return new SortParameters(fieldName, DESC);
    }

    /**
     * Creates empty sorting parameters that will not set any sort params in the query.
     * @return Sort parameters.
     */
    public static SortParameters none() {
        return NONE;
    }

    QueryStringBuilder asQueryStringBuilder() {
        if (fieldName == null || sortDirection == null) {
            return new QueryStringBuilder();
        }
        return new QueryStringBuilder()
            .appendParam("sort", fieldName)
            .appendParam("direction", sortDirection.name());
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy