• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 // Android-removed: Use Bits class to retrieve byte order.
29 // import jdk.internal.misc.Unsafe;
30 
31 /**
32  * A typesafe enumeration for byte orders.
33  *
34  * @author Mark Reinhold
35  * @author JSR-51 Expert Group
36  * @since 1.4
37  */
38 
39 public final class ByteOrder {
40 
41     private String name;
42 
ByteOrder(String name)43     private ByteOrder(String name) {
44         this.name = name;
45     }
46 
47     /**
48      * Constant denoting big-endian byte order.  In this order, the bytes of a
49      * multibyte value are ordered from most significant to least significant.
50      */
51     public static final ByteOrder BIG_ENDIAN
52         = new ByteOrder("BIG_ENDIAN");
53 
54     /**
55      * Constant denoting little-endian byte order.  In this order, the bytes of
56      * a multibyte value are ordered from least significant to most
57      * significant.
58      */
59     public static final ByteOrder LITTLE_ENDIAN
60         = new ByteOrder("LITTLE_ENDIAN");
61 
62     // BEGIN Android-removed: Use Bits class to retrieve native order.
63     /*
64     // Retrieve the native byte order. It's used early during bootstrap, and
65     // must be initialized after BIG_ENDIAN and LITTLE_ENDIAN.
66     private static final ByteOrder NATIVE_ORDER
67         = Unsafe.getUnsafe().isBigEndian()
68             ? ByteOrder.BIG_ENDIAN : ByteOrder.LITTLE_ENDIAN;
69     */
70     // END Android-removed: Use Bits class to retrieve native order.
71 
72     /**
73      * Retrieves the native byte order of the underlying platform.
74      *
75      * <p> This method is defined so that performance-sensitive Java code can
76      * allocate direct buffers with the same byte order as the hardware.
77      * Native code libraries are often more efficient when such buffers are
78      * used.  </p>
79      *
80      * @return  The native byte order of the hardware upon which this Java
81      *          virtual machine is running
82      */
nativeOrder()83     public static ByteOrder nativeOrder() {
84         // BEGIN Android-changed: Use Bits class to retrieve byte order.
85         /*
86         return NATIVE_ORDER;
87         */
88         // END Android-changed: Use Bits class to retrieve byte order.
89         return Bits.byteOrder();
90     }
91 
92     /**
93      * Constructs a string describing this object.
94      *
95      * <p> This method returns the string
96      * {@code "BIG_ENDIAN"} for {@link #BIG_ENDIAN} and
97      * {@code "LITTLE_ENDIAN"} for {@link #LITTLE_ENDIAN}.
98      *
99      * @return  The specified string
100      */
toString()101     public String toString() {
102         return name;
103     }
104 
105 }
106