source: branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Interfaces/IJsonItemConverter.cs @ 17519

using System;
using HeuristicLab.Core;

namespace HeuristicLab.JsonInterface {
  public interface IJsonItemConverter {
    /// <summary>
    /// Injects the saved infos from the JsonItem into the IItem.
    /// (Sets the necessary values.)
    /// </summary>
    /// <param name="item">The IItem which get the data injected.</param>
    /// <param name="data">The JsonItem with the saved values.</param>
    void Inject(IItem item, IJsonItem data, IJsonItemConverter root);

    /// <summary>
    /// Extracts all infos out of an IItem to create a JsonItem. 
    /// (For template generation.)
    /// </summary>
    /// <param name="value">The IItem to extract infos.</param>
    /// <returns>JsonItem with infos to reinitialise the IItem.</returns>
    IJsonItem Extract(IItem value, IJsonItemConverter root);

    /// <summary>
    /// The targeted type for the converter.
    /// </summary>
    Type ConvertableType { get; }

    /// <summary>
    /// A given priority, higher numbers are prior.
    /// </summary>
    int Priority { get; }
  }
}