1 /*
2  * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25
26 package java.nio;
27
28 import jdk.internal.misc.Unsafe;
29
30 /**
31  * A typesafe enumeration for byte orders.
32  *
33  * @author Mark Reinhold
34  * @author JSR-51 Expert Group
35  * @since 1.4
36  */
37
38 public final class ByteOrder {
39
40     private String name;
41
42     private ByteOrder(String name) {
43         this.name = name;
44     }
45
46     /**
47      * Constant denoting big-endian byte order.  In this order, the bytes of a
48      * multibyte value are ordered from most significant to least significant.
49      */
50     public static final ByteOrder BIG_ENDIAN
51         = new ByteOrder("BIG_ENDIAN");
52
53     /**
54      * Constant denoting little-endian byte order.  In this order, the bytes of
55      * a multibyte value are ordered from least significant to most
56      * significant.
57      */
58     public static final ByteOrder LITTLE_ENDIAN
59         = new ByteOrder("LITTLE_ENDIAN");
60
61     // Retrieve the native byte order. It's used early during bootstrap, and
62     // must be initialized after BIG_ENDIAN and LITTLE_ENDIAN.
63     private static final ByteOrder NATIVE_ORDER
64         = Unsafe.getUnsafe().isBigEndian()
65             ? ByteOrder.BIG_ENDIAN : ByteOrder.LITTLE_ENDIAN;
66
67     /**
68      * Retrieves the native byte order of the underlying platform.
69      *
70      * <p> This method is defined so that performance-sensitive Java code can
71      * allocate direct buffers with the same byte order as the hardware.
72      * Native code libraries are often more efficient when such buffers are
73      * used.  </p>
74      *
75      * @return  The native byte order of the hardware upon which this Java
76      *          virtual machine is running
77      */
78     public static ByteOrder nativeOrder() {
79         return NATIVE_ORDER;
80     }
81
82     /**
83      * Constructs a string describing this object.
84      *
85      * <p> This method returns the string
86      * {@code "BIG_ENDIAN"} for {@link #BIG_ENDIAN} and
87      * {@code "LITTLE_ENDIAN"} for {@link #LITTLE_ENDIAN}.
88      *
89      * @return  The specified string
90      */
91     public String toString() {
92         return name;
93     }
94
95 }
96