org.apache.poi.ss.usermodel.ReadingOrder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation

Apache POI - Java API To Access Microsoft Format Files

There is a newer version: 5.2.5

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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 org.apache.poi.ss.usermodel;

/**
 * The enumeration value indicating reading order of a cell,
 * i.e., whether the reading order is Context(Default), Left To Right or Right To Left
 */
public enum ReadingOrder {
    /**
     * The reading order is Context(Default).
     */
    CONTEXT,

    /**
     * The reading order is Left To Right.
     */
    LEFT_TO_RIGHT,

    /**
     * The reading order is Right To Left.
     */
    RIGHT_TO_LEFT;
    
    public short getCode() {
        return (short) ordinal();
    }

    public static ReadingOrder forLong(long code) {
        if (code < 0 || code >= values().length) {
            throw new IllegalArgumentException("Invalid ReadingOrder code: " + code);
        }
        return values()[(int)code];
    }
}