/* Copyright 2010-2014 MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using System;

namespace MongoDB.Bson
{
    /// <summary>
    /// Represents the BSON MaxKey value.
    /// </summary>
    [Serializable]
    public class BsonMaxKey : BsonValue, IComparable<BsonMaxKey>, IEquatable<BsonMaxKey>
    {
        // private static fields
        private static BsonMaxKey __value = new BsonMaxKey();

        // constructors
        // private so only the singleton instance can be created
        private BsonMaxKey()
            : base(BsonType.MaxKey)
        {
        }

        // public operators
        /// <summary>
        /// Compares two BsonMaxKey values.
        /// </summary>
        /// <param name="lhs">The first BsonMaxKey.</param>
        /// <param name="rhs">The other BsonMaxKey.</param>
        /// <returns>True if the two BsonMaxKey values are not equal according to ==.</returns>
        public static bool operator !=(BsonMaxKey lhs, BsonMaxKey rhs)
        {
            return !(lhs == rhs);
        }

        /// <summary>
        /// Compares two BsonMaxKey values.
        /// </summary>
        /// <param name="lhs">The first BsonMaxKey.</param>
        /// <param name="rhs">The other BsonMaxKey.</param>
        /// <returns>True if the two BsonMaxKey values are equal according to ==.</returns>
        public static bool operator ==(BsonMaxKey lhs, BsonMaxKey rhs)
        {
            if (object.ReferenceEquals(lhs, null)) { return object.ReferenceEquals(rhs, null); }
            return lhs.Equals(rhs);
        }

        // public static properties
        /// <summary>
        /// Gets the singleton instance of BsonMaxKey.
        /// </summary>
        public static BsonMaxKey Value { get { return __value; } }

        // public methods
        /// <summary>
        /// Compares this BsonMaxKey to another BsonMaxKey.
        /// </summary>
        /// <param name="other">The other BsonMaxKey.</param>
        /// <returns>A 32-bit signed integer that indicates whether this BsonMaxKey is less than, equal to, or greather than the other.</returns>
        public int CompareTo(BsonMaxKey other)
        {
            if (other == null) { return 1; }
            return 0; // it's a singleton
        }

        /// <summary>
        /// Compares the BsonMaxKey to another BsonValue.
        /// </summary>
        /// <param name="other">The other BsonValue.</param>
        /// <returns>A 32-bit signed integer that indicates whether this BsonMaxKey is less than, equal to, or greather than the other BsonValue.</returns>
        public override int CompareTo(BsonValue other)
        {
            if (other == null) { return 1; }
            if (other is BsonMaxKey) { return 0; }
            return 1;
        }

        /// <summary>
        /// Compares this BsonMaxKey to another BsonMaxKey.
        /// </summary>
        /// <param name="rhs">The other BsonMaxKey.</param>
        /// <returns>True if the two BsonMaxKey values are equal.</returns>
        public bool Equals(BsonMaxKey rhs)
        {
            if (object.ReferenceEquals(rhs, null) || GetType() != rhs.GetType()) { return false; }
            return true; // it's a singleton
        }

        /// <summary>
        /// Compares this BsonMaxKey to another object.
        /// </summary>
        /// <param name="obj">The other object.</param>
        /// <returns>True if the other object is a BsonMaxKey and equal to this one.</returns>
        public override bool Equals(object obj)
        {
            return Equals(obj as BsonMaxKey); // works even if obj is null or of a different type
        }

        /// <summary>
        /// Gets the hash code.
        /// </summary>
        /// <returns>The hash code.</returns>
        public override int GetHashCode()
        {
            return BsonType.GetHashCode();
        }

        /// <summary>
        /// Returns a string representation of the value.
        /// </summary>
        /// <returns>A string representation of the value.</returns>
        public override string ToString()
        {
            return "BsonMaxKey";
        }
    }
}