001package ball.game.card.trick.bridge;
002/*-
003 * ##########################################################################
004 * Game Applications and Utilities
005 * %%
006 * Copyright (C) 2010 - 2022 Allen D. Ball
007 * %%
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *      http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 * ##########################################################################
020 */
021
022/**
023 * Bridge position {@link Enum} type.
024 *
025 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
026 */
027public enum Position {
028    SOUTH, WEST, NORTH, EAST;
029
030    /**
031     * Method to determine the {@link Position} to the left of the argument
032     * {@link Position}.
033     *
034     * @param   right           The right {@link Position}.
035     *
036     * @return  The {@link Position} to the left.
037     */
038    public static Position leftOf(Position right) {
039        var values = values();
040
041        return values[(right.ordinal() + 1) % values.length];
042    }
043
044    /**
045     * Method to determine the {@link Position} to the right of the argument
046     * {@link Position}.
047     *
048     * @param   left            The left {@link Position}.
049     *
050     * @return  The {@link Position} to the left.
051     */
052    public static Position rightOf(Position left) {
053        var values = values();
054
055        return values[(left.ordinal() + values.length - 1) % values.length];
056    }
057}