1/*
2 * Copyright (c) 2000, 2002, 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
26package 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
37public final class ByteOrder {
38
39    private String name;
40
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     * </p>
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.  </p>
57     */
58    public static final ByteOrder LITTLE_ENDIAN
59            = new ByteOrder("LITTLE_ENDIAN");
60
61    /**
62     * Retrieves the native byte order of the underlying platform.
63     *
64     * <p> This method is defined so that performance-sensitive Java code can
65     * allocate direct buffers with the same byte order as the hardware.
66     * Native code libraries are often more efficient when such buffers are
67     * used.  </p>
68     *
69     * @return The native byte order of the hardware upon which this Java
70     * virtual machine is running
71     */
72    public static ByteOrder nativeOrder() {
73        return Bits.byteOrder();
74    }
75
76    /**
77     * Constructs a string describing this object.
78     *
79     * <p> This method returns the string <tt>"BIG_ENDIAN"</tt> for {@link
80     * #BIG_ENDIAN} and <tt>"LITTLE_ENDIAN"</tt> for {@link #LITTLE_ENDIAN}.
81     * </p>
82     *
83     * @return The specified string
84     */
85    public String toString() {
86        return name;
87    }
88
89}
90