/* 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; using System.Text; namespace MongoDB.Bson.IO { /// /// Represents settings for a BsonBinaryWriter. /// [Serializable] public class BsonBinaryWriterSettings : BsonWriterSettings { // private static fields private static BsonBinaryWriterSettings __defaults = null; // delay creation to pick up the latest default values // private fields private bool _closeOutput = false; private UTF8Encoding _encoding = new UTF8Encoding(false, true); private bool _fixOldBinarySubTypeOnOutput = true; private int _maxDocumentSize = BsonDefaults.MaxDocumentSize; // constructors /// /// Initializes a new instance of the BsonBinaryWriterSettings class. /// public BsonBinaryWriterSettings() { } /// /// Initializes a new instance of the BsonBinaryWriterSettings class. /// /// Whether to close the output stream when the writer is closed. /// Whether to fix old binary data subtype on output. /// The representation for Guids. /// The max document size. [Obsolete("Use the no-argument constructor instead and set the properties.")] public BsonBinaryWriterSettings( bool closeOutput, bool fixOldBinarySubTypeOnOutput, GuidRepresentation guidRepresentation, int maxDocumentSize) : base(guidRepresentation) { _closeOutput = closeOutput; _fixOldBinarySubTypeOnOutput = fixOldBinarySubTypeOnOutput; _maxDocumentSize = maxDocumentSize; } // public static properties /// /// Gets or sets the default BsonBinaryWriter settings. /// public static BsonBinaryWriterSettings Defaults { get { if (__defaults == null) { __defaults = new BsonBinaryWriterSettings(); } return __defaults; } set { __defaults = value; } } // public properties /// /// Gets or sets whether to close the output when the writer is closed. /// public bool CloseOutput { get { return _closeOutput; } set { if (IsFrozen) { throw new InvalidOperationException("BsonBinaryWriterSettings is frozen."); } _closeOutput = value; } } /// /// Gets or sets the Encoding. /// public UTF8Encoding Encoding { get { return _encoding; } set { if (value == null) { throw new ArgumentNullException("value"); } if (IsFrozen) { throw new InvalidOperationException("BsonBinaryWriterSettings is frozen."); } _encoding = value; } } /// /// Gets or sets whether to fix the old binary data subtype on output. /// public bool FixOldBinarySubTypeOnOutput { get { return _fixOldBinarySubTypeOnOutput; } set { if (IsFrozen) { throw new InvalidOperationException("BsonBinaryWriterSettings is frozen."); } _fixOldBinarySubTypeOnOutput = value; } } /// /// Gets or sets the max document size. /// public int MaxDocumentSize { get { return _maxDocumentSize; } set { if (IsFrozen) { throw new InvalidOperationException("BsonBinaryWriterSettings is frozen."); } _maxDocumentSize = value; } } // public methods /// /// Creates a clone of the settings. /// /// A clone of the settings. public new BsonBinaryWriterSettings Clone() { return (BsonBinaryWriterSettings)CloneImplementation(); } // protected methods /// /// Creates a clone of the settings. /// /// A clone of the settings. protected override BsonWriterSettings CloneImplementation() { var clone = new BsonBinaryWriterSettings { CloseOutput = _closeOutput, Encoding = _encoding, FixOldBinarySubTypeOnOutput = _fixOldBinarySubTypeOnOutput, GuidRepresentation = GuidRepresentation, MaxDocumentSize = _maxDocumentSize, MaxSerializationDepth = MaxSerializationDepth }; return clone; } } }