Free cookie consent management tool by TermsFeed Policy Generator

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

Last change on this file since 17399 was 17394, checked in by dpiringe, 5 years ago

#3026:

  • deleted: ConvertableAttribute, DummyConverter, ObjectExtensions
  • renamed: CustomJsonWriter -> SingleLineArrayJsonWriter, JCInstantiator -> JsonTemplateInstantiator
  • added: JsonItemConverterFactory, UnsupportedJsonItem
  • IJsonItemConverter:
    • added two new properties: Priority and ConvertableType -> because converters are automatically collected by plugin infrastructure now
    • Extract, Inject references a root converter now -> typically an instance of JsonItemConverter -> to prevent cycles
  • JsonItemConverter:
    • now implements the interface IJsonItemConverter
    • is now a dynamic class
    • is only instantiable with an factory (JsonItemConverterFactory)
    • still has the old (but now public) static methods Extract and Inject (without ref param IJsonItemConverter root) -> creates instance with factory and calls methods of instance
    • removed register and unregister methods, because the factory collects all converters automatically now (on first call of Create)
    • has cycle detection for Extract and Inject
    • renamed method Get to GetConverter
File size: 1.0 KB
Line 
1using System;
2using System.Collections.Generic;
3using System.Linq;
4using System.Text;
5using System.Threading.Tasks;
6using HeuristicLab.Core;
7using Newtonsoft.Json.Linq;
8
9namespace HeuristicLab.JsonInterface {
10  public interface IJsonItemConverter {
11    /// <summary>
12    /// Injects the saved infos from the JsonItem into the IItem.
13    /// (Sets the necessary values.)
14    /// </summary>
15    /// <param name="item">The IItem which get the data injected.</param>
16    /// <param name="data">The JsonItem with the saved values.</param>
17    void Inject(IItem item, JsonItem data, IJsonItemConverter root);
18
19    /// <summary>
20    /// Extracts all infos out of an IItem to create a JsonItem.
21    /// (For template generation.)
22    /// </summary>
23    /// <param name="value">The IItem to extract infos.</param>
24    /// <returns>JsonItem with infos to reinitialise the IItem.</returns>
25    JsonItem Extract(IItem value, IJsonItemConverter root);
26
27    Type ConvertableType { get; }
28    int Priority { get; }
29  }
30}
31
Note: See TracBrowser for help on using the repository browser.