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 
29 /**
30  * A typesafe enumeration for byte orders.
31  *
32  * @author Mark Reinhold
33  * @author JSR-51 Expert Group
34  * @since 1.4
35  */
36 
37 public final class ByteOrder {
38 
39     private String name;
40 
ByteOrder(String name)41     private ByteOrder(String name) {
42         this.name = name;
43     }
44 
45     /**
46      * Constant denoting big-endian byte order.  In this order, the bytes of a
47      * multibyte value are ordered from most significant to least significant.
48      */
49     public static final ByteOrder BIG_ENDIAN
50             = new ByteOrder("BIG_ENDIAN");
51 
52     /**
53      * Constant denoting little-endian byte order.  In this order, the bytes of
54      * a multibyte value are ordered from least significant to most.
55      */
56     public static final ByteOrder LITTLE_ENDIAN
57             = new ByteOrder("LITTLE_ENDIAN");
58 
59     /**
60      * Retrieves the native byte order of the underlying platform.
61      *
62      * <p> This method is defined so that performance-sensitive Java code can
63      * allocate direct buffers with the same byte order as the hardware.
64      * Native code libraries are often more efficient when such buffers are
65      * used.  </p>
66      *
67      * @return The native byte order of the hardware upon which this Java
68      * virtual machine is running
69      */
nativeOrder()70     public static ByteOrder nativeOrder() {
71         return Bits.byteOrder();
72     }
73 
74     /**
75      * Constructs a string describing this object.
76      *
77      * <p> This method returns the string <tt>"BIG_ENDIAN"</tt> for {@link
78      * #BIG_ENDIAN} and <tt>"LITTLE_ENDIAN"</tt> for {@link #LITTLE_ENDIAN}.
79      * </p>
80      *
81      * @return The specified string
82      */
toString()83     public String toString() {
84         return name;
85     }
86 
87 }
88