Source for java.nio.ByteOrder

   1: /* ByteOrder.java -- 
   2:    Copyright (C) 2002, 2004  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.nio;
  40: 
  41: /**
  42:  * @author Michael Koch (konqueror@gmx.de)
  43:  * @since 1.4
  44:  */
  45: public final class ByteOrder
  46: {
  47:   /**
  48:    * Constant indicating big endian byte order.
  49:    */
  50:   public static final ByteOrder BIG_ENDIAN = new ByteOrder();
  51: 
  52:   /**
  53:    * Constant indicating little endian byte order.
  54:    */
  55:   public static final ByteOrder LITTLE_ENDIAN = new ByteOrder();
  56: 
  57:   /**
  58:    * Returns the native byte order of the platform currently running.
  59:    *
  60:    * @return the native byte order
  61:    */
  62:   public static ByteOrder nativeOrder()
  63:   {
  64:     // Let this fail with an NPE when the property is not set correctly.
  65:     // Otherwise we risk that NIO is silently working wrong.
  66:     return (System.getProperty("gnu.cpu.endian").equals("big")
  67:             ? BIG_ENDIAN : LITTLE_ENDIAN);
  68:   }
  69: 
  70:   /**
  71:    * Returns a string representation of the byte order.
  72:    *
  73:    * @return the string
  74:    */
  75:   public String toString()
  76:   {
  77:     return this == BIG_ENDIAN ? "BIG_ENDIAN" : "LITTLE_ENDIAN";
  78:   }
  79: 
  80:   // This class can only be instantiated here.
  81:   private ByteOrder()
  82:   {
  83:   }
  84: }