com.ocs.dynamo.dao.SortOrder.java Source code

Introduction

Here is the source code for com.ocs.dynamo.dao.SortOrder.java

Source

/*
   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.ocs.dynamo.dao;

import java.io.Serializable;

import org.apache.commons.lang.ObjectUtils;
import org.apache.commons.lang.builder.ReflectionToStringBuilder;

import com.ocs.dynamo.exception.OCSRuntimeException;

/**
 * Object representing a sort order and direction
 * 
 * @author bas.rutten
 */
public class SortOrder implements Serializable {

    private static final long serialVersionUID = -4702369564151453555L;

    private static final Direction DEFAULT_DIRECTION = Direction.ASC;

    private final Direction direction;

    private final String property;

    public enum Direction {

        ASC, DESC;

        /**
         * Translates the provided String into the corresponding Direction enum
         * 
         * @param value
         *            the String representation of the Direction
         * @return
         */
        public static Direction fromString(String value) {
            try {
                return Direction.valueOf(value.toUpperCase());
            } catch (Exception e) {
                throw new OCSRuntimeException(String.format("Sort order %s is not recognized", value), e);
            }
        }
    }

    /**
     * Constructor
     * 
     * @param direction
     *            the desired sort direction
     * @param property
     *            the property to sort on
     */
    public SortOrder(Direction direction, String property) {
        this.direction = direction == null ? DEFAULT_DIRECTION : direction;
        this.property = property;
    }

    /**
     * Constructor
     * 
     * @param property
     *            the property to sort on (in ascending direction)
     */
    public SortOrder(String property) {
        this(DEFAULT_DIRECTION, property);
    }

    public Direction getDirection() {
        return direction;
    }

    public String getProperty() {
        return property;
    }

    public boolean isAscending() {
        return this.direction.equals(Direction.ASC);
    }

    public SortOrder with(Direction order) {
        return new SortOrder(order, this.property);
    }

    @Override
    public int hashCode() {
        int result = 13;
        result = 43 * result + ObjectUtils.hashCode(direction);
        result = 53 * result + ObjectUtils.hashCode(property);
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof SortOrder)) {
            return false;
        }

        SortOrder that = (SortOrder) obj;
        return ObjectUtils.equals(this.direction, that.direction)
                && ObjectUtils.equals(this.property, that.property);
    }

    @Override
    public String toString() {
        return ReflectionToStringBuilder.toString(this);
    }
}