summaryrefslogtreecommitdiff
path: root/src/main/java/com/amazon/carbonado/info/Direction.java
blob: 67d003ac5272574fa0235034cf30ae7665c6966e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
 * Copyright 2006 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * 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.amazon.carbonado.info;

/**
 * Describes a property sorting direction.
 *
 * @author Brian S O'Neill
 */
public enum Direction {
    ASCENDING('+'), DESCENDING('-'), UNSPECIFIED('~');

    private char mCharValue;

    private Direction(char charValue) {
        mCharValue = charValue;
    }

    /**
     * Returns the reverse direction of this.
     */
    public Direction reverse() {
        if (this == ASCENDING) {
            return DESCENDING;
        } else if (this == DESCENDING) {
            return ASCENDING;
        }
        return this;
    }

    /**
     * Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
     */
    public char toCharacter() {
        return mCharValue;
    }

    /**
     * Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything
     * else.
     */
    public static Direction fromCharacter(char c) {
        if (c == '+') {
            return ASCENDING;
        }
        if (c == '-') {
            return DESCENDING;
        }
        return UNSPECIFIED;
    }
}