// This file is part of YamlDotNet - A .NET library for YAML.
// Copyright (c) Antoine Aubry and contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
// of the Software, and to permit persons to whom the Software is furnished to do
// so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
using System;
using System.IO;
using YamlDotNet.Core;
using YamlDotNet.Core.Events;
namespace YamlDotNet.Serialization
{
public sealed class Serializer : ISerializer
{
private readonly IValueSerializer valueSerializer;
private readonly EmitterSettings emitterSettings;
///
/// Initializes a new instance of using the default configuration.
///
///
/// To customize the behavior of the serializer, use .
///
public Serializer()
: this(new SerializerBuilder().BuildValueSerializer(), EmitterSettings.Default)
{
}
///
/// This constructor is private to discourage its use.
/// To invoke it, call the method.
///
private Serializer(IValueSerializer valueSerializer, EmitterSettings emitterSettings)
{
this.valueSerializer = valueSerializer ?? throw new ArgumentNullException(nameof(valueSerializer));
this.emitterSettings = emitterSettings ?? throw new ArgumentNullException(nameof(emitterSettings));
}
///
/// Creates a new that uses the specified .
/// This method is available for advanced scenarios. The preferred way to customize the behavior of the
/// deserializer is to use .
///
public static Serializer FromValueSerializer(IValueSerializer valueSerializer, EmitterSettings emitterSettings)
{
return new Serializer(valueSerializer, emitterSettings);
}
///
/// Serializes the specified object.
///
/// The where to serialize the object.
/// The object to serialize.
public void Serialize(TextWriter writer, object graph)
{
Serialize(new Emitter(writer, emitterSettings), graph);
}
///
/// Serializes the specified object into a string.
///
/// The object to serialize.
public string Serialize(object graph)
{
using var buffer = new StringWriter();
Serialize(buffer, graph);
return buffer.ToString();
}
///
/// Serializes the specified object.
///
/// The where to serialize the object.
/// The object to serialize.
/// The static type of the object to serialize.
public void Serialize(TextWriter writer, object graph, Type type)
{
Serialize(new Emitter(writer, emitterSettings), graph, type);
}
///
/// Serializes the specified object.
///
/// The where to serialize the object.
/// The object to serialize.
public void Serialize(IEmitter emitter, object graph)
{
if (emitter == null)
{
throw new ArgumentNullException(nameof(emitter));
}
EmitDocument(emitter, graph, null);
}
///
/// Serializes the specified object.
///
/// The where to serialize the object.
/// The object to serialize.
/// The static type of the object to serialize.
public void Serialize(IEmitter emitter, object graph, Type type)
{
if (emitter == null)
{
throw new ArgumentNullException(nameof(emitter));
}
if (type == null)
{
throw new ArgumentNullException(nameof(type));
}
EmitDocument(emitter, graph, type);
}
private void EmitDocument(IEmitter emitter, object graph, Type? type)
{
emitter.Emit(new StreamStart());
emitter.Emit(new DocumentStart());
valueSerializer.SerializeValue(emitter, graph, type);
emitter.Emit(new DocumentEnd(true));
emitter.Emit(new StreamEnd());
}
}
}