DanielWillett.JavaPropertiesParser 1.1.0

JavaPropertiesParser

Parses and writes Java Properties data.

Installation

Install the latest release of the package from NuGet.

Features

• Fully conforms to the "spec".
• Supports escape sequences (\n, \r, \t, \\, \u0D9E).
• Supports multi-line values by ending a line with a backslash.
• Can parse comments and empty lines if needed.
• Configurable options (see PropertiesReaderOptions).
• Support the following property separators (:, =, whitespace).
• Opt-in support for using / and // as comment characters.
  • Must set RecognizeSlashComments = true on the reader.
• Well tested

Examples

Writing - Write a few pairs of data

using StringWriter stringWriter = new StringWriter();
using (PropertiesWriter writer = new PropertiesWriter(stringWriter))
{
    writer.Separator = '=';

    writer.WriteKey("JustASingleKey");
    writer.WriteKeyValue("Key", "Value");

    writer.WriteLine();

    writer.WriteComment("Animals");
    writer.WriteKeyValue("Dog", "Land");
    writer.WriteKeyValue("Cat", "Land");
    writer.WriteKeyValue("Fish", "Water");

    writer.WriteLine();
    writer.WriteLine();

    writer.WriteComment(
        "The following states are important for some reason",
        PropertiesCommentType.ExclamationWrapped
    );
    writer.WriteKey("States");
    string[] states = [ "NC", "GA", "NY", "AK", "CA", "HI", "TX" ];
    for (int i = 0; i < states.Length; ++i)
    {
        writer.WriteValue(i == states.Length - 1 ? states[i] : $"{states[i]}, ");
    }
}

Console.WriteLine(stringWriter.ToString());

Output:

JustASingleKey
Key = Value

# Animals
Dog = Land
Cat = Land
Fish = Water


! The following states are important for some reason !
States = NC, \
         GA, \
         NY, \
         AK, \
         CA, \
         HI, \
         TX

Reading - Loop through all keys and values

string filePath = "./file.txt";
using PropertiesReader reader = new PropertiesReader(filePath);

while (reader.TryReadPair(out string key, out string value, skipKeysWithNoValue: true))
{
    Console.WriteLine($"{key} = {value}");
}

Output (using file.txt):

> Property1 = Value1
  Property3 = Value2

Reading - Print all comments

const string content = """
                       ! This represents the time at which you will go to sleep tonight
                       Time: 4:30 AM
                              
                       # This feature only works on Windows.
                       OS: Windows
                              
                       # Comments can also be 'wrapped' like this #
                       """;

using PropertiesReader reader = new PropertiesReader(new StringReader(content), disposeReaderOnDispose: true);

while (reader.TryRead())
{
    if (reader.TokenType == PropertiesTokenType.Comment)
        Console.WriteLine($"{reader.CommentType, -16} \"{reader.Value}\"");
}

Output:

> Exclamation      "This represents the time at which you will go to sleep tonight"
  Hashtag          "This feature only works on Windows."
  HashtagWrapped   "Comments can also be 'wrapped' like this"