com.bld.commons.reflection.model.OrderBy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-jpa-service Show documentation

The newest version!

/**
 * @author Francesco Baldi
 * @mail [email protected]
 * @class bld.commons.reflection.model.OrderBy.java
 */
package com.bld.commons.reflection.model;

import java.io.Serializable;

import com.bld.commons.reflection.type.OrderType;
import com.bld.commons.utils.json.annotations.CleanExcessSpaces;

import jakarta.validation.constraints.NotNull;


/**
 * The Class OrderBy.
 */
@SuppressWarnings("serial")
public class OrderBy implements Serializable {

	/** The sort key. */
	@NotNull
	@CleanExcessSpaces(removeAllSpaceType = true)
	private String sortKey;

	/** The order type. */
	private OrderType orderType;

	/**
	 * Instantiates a new order by.
	 */
	public OrderBy() {
		super();
		orderType = OrderType.asc;
	}

	/**
	 * Instantiates a new order by.
	 *
	 * @param sortKey   the sort key
	 * @param orderType the order type
	 */
	private OrderBy(String sortKey, OrderType orderType) {
		super();
		this.sortKey = sortKey;
		this.orderType = OrderType.asc;
		if (orderType != null)
			this.orderType = orderType;
	}
	
	/**
	 * Of.
	 *
	 * @param sortKey the sort key
	 * @param orderType the order type
	 * @return the order by
	 */
	public static OrderBy of(String sortKey, OrderType orderType) {
		return new OrderBy(sortKey, orderType);
	}

	/**
	 * Gets the sort key.
	 *
	 * @return the sort key
	 */
	public String getSortKey() {
		return sortKey;
	}

	/**
	 * Sets the sort key.
	 *
	 * @param sortKey the new sort key
	 */
	public void setSortKey(String sortKey) {
		this.sortKey = sortKey;
	}

	/**
	 * Gets the order type.
	 *
	 * @return the order type
	 */
	public OrderType getOrderType() {
		return orderType;
	}

	/**
	 * Sets the order type.
	 *
	 * @param orderType the new order type
	 */
	public void setOrderType(OrderType orderType) {
		this.orderType = orderType;
	}

}