From 269bc83c88bbcae0d7326f57ddcae259d22a0f7f Mon Sep 17 00:00:00 2001 From: Vladimir Krivosheev Date: Wed, 14 Mar 2018 16:02:43 +0100 Subject: [PATCH] IDEA-CR-30551 add package.html --- .../util/xmlb/annotations/package.html | 66 +++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 platform/util/src/com/intellij/util/xmlb/annotations/package.html diff --git a/platform/util/src/com/intellij/util/xmlb/annotations/package.html b/platform/util/src/com/intellij/util/xmlb/annotations/package.html new file mode 100644 index 000000000000..5255d78843ec --- /dev/null +++ b/platform/util/src/com/intellij/util/xmlb/annotations/package.html @@ -0,0 +1,66 @@ +

Please consider to use annotation parameters only to achieve backward compatibility. Otherwise feel free to file issues about serialization cosmetics.

+

Lists and Sets

+

XCollection annotation intended to customize list and set serialization.

+

Two styles are provided:

+ +

Where second-level option it is item element (use elementName to customize element name) and +value it is value attribute (use valueAttributeName to customize attribute name).

+

Because of backward compatibility, v1 style is used by default. In the examples v2 style is used.

+

Custom List Item Value Attribute Name

+

Value of primitive type wrapped into element named option. valueAttributeName allows you to customize name of value attribute.

+

Empty name is allowed — in this case value will be serialized as element text.

+ +

Maps

+

XMap annotation intended to customize map serialization and to enable new serialization format.

+ +

So, it is recommended to always specify XMap annotation.