|
// ==++==
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// ==--==
/*============================================================
**
** Class: Byte
**
**
** Purpose: This class will encapsulate a byte and provide an
** Object representation of it.
**
**
===========================================================*/
namespace System {
using System;
using System.Globalization;
///#if GENERICS_WORK
/// using System.Numerics;
///#endif
using System.Runtime.InteropServices;
using System.Diagnostics.Contracts;
// The Byte class extends the Value class and
// provides object representation of the byte primitive type.
//
[System.Runtime.InteropServices.ComVisible(true)]
[Serializable]
[System.Runtime.InteropServices.StructLayout(LayoutKind.Sequential)]
#if GENERICS_WORK
public struct Byte : IComparable, IFormattable, IConvertible
, IComparable<Byte>, IEquatable<Byte>
/// , IArithmetic<Byte>
#else
public struct Byte : IComparable, IFormattable, IConvertible
#endif
{
private byte m_value;
// The maximum value that a Byte may represent: 255.
public const byte MaxValue = (byte)0xFF;
// The minimum value that a Byte may represent: 0.
public const byte MinValue = 0;
// Compares this object to another object, returning an integer that
// indicates the relationship.
// Returns a value less than zero if this object
// null is considered to be less than any instance.
// If object is not of type byte, this method throws an ArgumentException.
//
public int CompareTo(Object value) {
if (value == null) {
return 1;
}
if (!(value is Byte)) {
throw new ArgumentException(Environment.GetResourceString("Arg_MustBeByte"));
}
return m_value - (((Byte)value).m_value);
}
public int CompareTo(Byte value) {
return m_value - value;
}
// Determines whether two Byte objects are equal.
public override bool Equals(Object obj) {
if (!(obj is Byte)) {
return false;
}
return m_value == ((Byte)obj).m_value;
}
[System.Runtime.Versioning.NonVersionable]
public bool Equals(Byte obj)
{
return m_value == obj;
}
// Gets a hash code for this instance.
public override int GetHashCode() {
return m_value;
}
[Pure]
public static byte Parse(String s) {
return Parse(s, NumberStyles.Integer, NumberFormatInfo.CurrentInfo);
}
[Pure]
public static byte Parse(String s, NumberStyles style) {
NumberFormatInfo.ValidateParseStyleInteger(style);
return Parse(s, style, NumberFormatInfo.CurrentInfo);
}
[Pure]
public static byte Parse(String s, IFormatProvider provider) {
return Parse(s, NumberStyles.Integer, NumberFormatInfo.GetInstance(provider));
}
// Parses an unsigned byte from a String in the given style. If
// a NumberFormatInfo isn't specified, the current culture's
// NumberFormatInfo is assumed.
[Pure]
public static byte Parse(String s, NumberStyles style, IFormatProvider provider) {
NumberFormatInfo.ValidateParseStyleInteger(style);
return Parse(s, style, NumberFormatInfo.GetInstance(provider));
}
private static byte Parse(String s, NumberStyles style, NumberFormatInfo info) {
int i = 0;
try {
i = Number.ParseInt32(s, style, info);
}
catch(OverflowException e) {
throw new OverflowException(Environment.GetResourceString("Overflow_Byte"), e);
}
if (i < MinValue || i > MaxValue) throw new OverflowException(Environment.GetResourceString("Overflow_Byte"));
return (byte)i;
}
public static bool TryParse(String s, out Byte result) {
return TryParse(s, NumberStyles.Integer, NumberFormatInfo.CurrentInfo, out result);
}
public static bool TryParse(String s, NumberStyles style, IFormatProvider provider, out Byte result) {
NumberFormatInfo.ValidateParseStyleInteger(style);
return TryParse(s, style, NumberFormatInfo.GetInstance(provider), out result);
}
private static bool TryParse(String s, NumberStyles style, NumberFormatInfo info, out Byte result) {
result = 0;
int i;
if (!Number.TryParseInt32(s, style, info, out i)) {
return false;
}
if (i < MinValue || i > MaxValue) {
return false;
}
result = (byte) i;
return true;
}
[Pure]
[System.Security.SecuritySafeCritical] // auto-generated
public override String ToString() {
Contract.Ensures(Contract.Result<String>() != null);
return Number.FormatInt32(m_value, null, NumberFormatInfo.CurrentInfo);
}
[Pure]
[System.Security.SecuritySafeCritical] // auto-generated
public String ToString(String format) {
Contract.Ensures(Contract.Result<String>() != null);
return Number.FormatInt32(m_value, format, NumberFormatInfo.CurrentInfo);
}
[Pure]
[System.Security.SecuritySafeCritical] // auto-generated
public String ToString(IFormatProvider provider) {
Contract.Ensures(Contract.Result<String>() != null);
return Number.FormatInt32(m_value, null, NumberFormatInfo.GetInstance(provider));
}
[Pure]
[System.Security.SecuritySafeCritical] // auto-generated
public String ToString(String format, IFormatProvider provider) {
Contract.Ensures(Contract.Result<String>() != null);
return Number.FormatInt32(m_value, format, NumberFormatInfo.GetInstance(provider));
}
//
// IConvertible implementation
//
[Pure]
public TypeCode GetTypeCode() {
return TypeCode.Byte;
}
/// <internalonly/>
bool IConvertible.ToBoolean(IFormatProvider provider) {
return Convert.ToBoolean(m_value);
}
/// <internalonly/>
char IConvertible.ToChar(IFormatProvider provider) {
return Convert.ToChar(m_value);
}
/// <internalonly/>
sbyte IConvertible.ToSByte(IFormatProvider provider) {
return Convert.ToSByte(m_value);
}
/// <internalonly/>
byte IConvertible.ToByte(IFormatProvider provider) {
return m_value;
}
/// <internalonly/>
short IConvertible.ToInt16(IFormatProvider provider) {
return Convert.ToInt16(m_value);
}
/// <internalonly/>
ushort IConvertible.ToUInt16(IFormatProvider provider) {
return Convert.ToUInt16(m_value);
}
/// <internalonly/>
int IConvertible.ToInt32(IFormatProvider provider) {
return Convert.ToInt32(m_value);
}
/// <internalonly/>
uint IConvertible.ToUInt32(IFormatProvider provider) {
return Convert.ToUInt32(m_value);
}
/// <internalonly/>
long IConvertible.ToInt64(IFormatProvider provider) {
return Convert.ToInt64(m_value);
}
/// <internalonly/>
ulong IConvertible.ToUInt64(IFormatProvider provider) {
return Convert.ToUInt64(m_value);
}
/// <internalonly/>
float IConvertible.ToSingle(IFormatProvider provider) {
return Convert.ToSingle(m_value);
}
/// <internalonly/>
double IConvertible.ToDouble(IFormatProvider provider) {
return Convert.ToDouble(m_value);
}
/// <internalonly/>
Decimal IConvertible.ToDecimal(IFormatProvider provider) {
return Convert.ToDecimal(m_value);
}
/// <internalonly/>
DateTime IConvertible.ToDateTime(IFormatProvider provider) {
throw new InvalidCastException(Environment.GetResourceString("InvalidCast_FromTo", "Byte", "DateTime"));
}
/// <internalonly/>
Object IConvertible.ToType(Type type, IFormatProvider provider) {
return Convert.DefaultToType((IConvertible)this, type, provider);
}
///#if GENERICS_WORK
/// //
/// // IArithmetic<Byte> implementation
/// //
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.AbsoluteValue(out bool overflowed) {
/// overflowed = false;
/// return m_value;
/// }
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.Negate(out bool overflowed) {
/// overflowed = (m_value != 0);
/// return m_value;
/// }
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.Sign(out bool overflowed) {
/// overflowed = false;
/// return (byte) (m_value == 0 ? 0 : 1);
/// }
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.Add(Byte addend, out bool overflowed) {
/// uint u = ((uint)m_value) + addend;
/// overflowed = (u > MaxValue);
/// return (byte) u;
/// }
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.Subtract(Byte subtrahend, out bool overflowed) {
/// int i = ((int)m_value) - subtrahend;
/// overflowed = (i < MinValue);
/// return (byte) i;
/// }
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.Multiply(Byte multiplier, out bool overflowed) {
/// uint u = ((uint)m_value) * multiplier;
/// overflowed = (u > MaxValue);
/// return (byte) u;
/// }
///
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.Divide(Byte divisor, out bool overflowed) {
/// overflowed = false;
/// return (byte) (m_value / divisor); // divide by zero will fail
/// }
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.DivideRemainder(Byte divisor, out Byte remainder, out bool overflowed) {
/// overflowed = false;
/// remainder = (byte) (m_value % divisor);
/// return (byte) (m_value / divisor); // divide by zero will fail
/// }
///
/// /// <internalonly/>
/// Byte IArithmetic<Byte>.Remainder(Byte divisor, out bool overflowed) {
/// overflowed = false;
/// return (byte) (m_value % divisor);
/// }
///
/// /// <internalonly/>
/// ArithmeticDescriptor<Byte> IArithmetic<Byte>.GetDescriptor() {
/// if (s_descriptor == null) {
/// s_descriptor = new ByteArithmeticDescriptor( ArithmeticCapabilities.One
/// | ArithmeticCapabilities.Zero
/// | ArithmeticCapabilities.MaxValue
/// | ArithmeticCapabilities.MinValue
/// | ArithmeticCapabilities.Unsigned);
/// }
/// return s_descriptor;
/// }
///
/// private static ByteArithmeticDescriptor s_descriptor;
///
/// class ByteArithmeticDescriptor : ArithmeticDescriptor<Byte> {
///
/// public ByteArithmeticDescriptor(ArithmeticCapabilities capabilities) : base(capabilities) {}
///
/// public override Byte One {
/// get {
/// return (Byte) 1;
/// }
/// }
///
/// public override Byte Zero {
/// get {
/// return (Byte) 0;
/// }
/// }
///
/// public override Byte MinValue {
/// get {
/// return Byte.MinValue;
/// }
/// }
///
/// public override Byte MaxValue {
/// get {
/// return Byte.MaxValue;
/// }
/// }
/// }
///#endif // #if GENERICS_WORK
}
}
|