001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.common;
017
018import com.fasterxml.jackson.annotation.JsonCreator;
019import com.fasterxml.jackson.annotation.JsonValue;
020
021/**
022 * Represents the sort order for resources returned.
023 *
024 * @since 8.4.0
025 */
026public enum SortOrder {
027        /**
028         * Ascending (asc)
029         */
030        ASCENDING,
031
032        /**
033         * Descending (desc)
034         */
035        DESCENDING;
036
037        @JsonCreator
038        public static SortOrder fromString(String value) {
039                if (value == null || value.isEmpty()) return null;
040                switch (value.toLowerCase()) {
041                        case "asc": case "ascending": return ASCENDING;
042                        case "desc": case "descending": return DESCENDING;
043                        default: throw new IllegalArgumentException("Unknown SortOrder: "+value);
044                }
045        }
046
047        @JsonValue
048        @Override
049        public String toString() {
050        return this == SortOrder.ASCENDING ? "asc" : "desc";
051    }
052}