Mapping a certain JSON value to Enum value C#

Question

I am creating classes for the Stack Exchange API. The filter_object type contains a member filter_type which will be either safe, unsafe, or invalid. So I created an enum like this:

[JsonConverter(typeof(StringEnumConverter))]
public enum FilterType
{
    safe,
    @unsafe, // Here lies the problem.
    invalid
}

Since unsafe is a keyword, I had to add some prefix to it. But how can I make the value "unsafe" to automatically map to @unsafe? Example JSON:

{
  "filter": "....",
  "filter_type": "unsafe",
  "included_fields": [
    "...",
    "....",
    "....."
  ]
}

How can I deserialize it, such that the filter_type is automatically converted to FilterType.@unsafe?

Update - Solved:

Using the @ symbol before an identifier makes it possible to be the same as keywords. It works fine even though the @ appears in intellisense.

You can also use uppercase like you do for class names etc in C#. And add a camelcase converter, see this question — huysentruitw
– huysentruitw, Commented Dec 10, 2015 at 22:01
@AlbertoMonteiro That was not the correct answer. Even if unmapped, if the names are correct, it will automatically get parsed as the correct enum. The problem was that unsafe is a keyword. I already came across prefixing @ so that a keyword can be used as an identifier. It appeared in intellisense and so I thought it was not working. But on testing I found it was correct. Seeing that there were no other answers, I accepted yours. However, that's not what is done. So I unaccepted it and edited my question to include the solution. I don't see any wrong in it. — Fᴀʀʜᴀɴ Aɴᴀᴍ
– Fᴀʀʜᴀɴ Aɴᴀᴍ, Commented Dec 21, 2015 at 18:17
@AlbertoMonteiro And i would have downvoted it because it was not the correct solution but the vote is locked. The JsonProperty maps to properties, not values. Because it already contained the @, it worked. Try it with _unsafe. Your method will throw an exception. — Fᴀʀʜᴀɴ Aɴᴀᴍ
– Fᴀʀʜᴀɴ Aɴᴀᴍ, Commented Dec 21, 2015 at 18:29

Alberto Monteiro · Accepted Answer · 2015-12-21 20:32:21Z

6

You can use JsonProperty, like this

public enum FilterType
{
    safe,
    [JsonProperty("unsafe")]
    @unsafe, // Here lies the problem.
    invalid
}

And then it will work properly

class MyClass
{
    public FilterType filter_type { get; set; } 
}

public class Program
{
    public static void Main()
    {
        var myClass = JsonConvert.DeserializeObject<MyClass>(json);
        var itsUnsafe = myClass.filter_type == FilterType.@unsafe;
        Console.WriteLine(itsUnsafe);
    }

    public static string json = @"{
  ""filter"": ""...."",
  ""filter_type"": ""unsafe"",
  ""included_fields"": [
    ""..."",
    ""...."",
    "".....""
  ]
}";
}

The output is:

true

You can see example working here: https://dotnetfiddle.net/6sb3VY

edited Dec 21, 2015 at 20:32

answered Dec 10, 2015 at 21:33

Alberto Monteiro

6,2792 gold badges31 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Mapping a certain JSON value to Enum value C#

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related