Details
-
Type:
New Feature
-
Status:
Open
-
Priority:
Minor
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: None
-
Component/s: IO
-
Labels:None
Description
In certain cases is required that XStream produces a human-readable XML-output containing also explanatory comments. This is, however, with the actual HierarchicalStreamWriter not realizable; accessing the underlying raw stream while the HierarchicalStreamWriter is open, is also very unsafe.
An adequate method on HierarchicalStreamWriter for writing comments - at least in certain states - would be nice.
Activity
Due to the nature of the comments (i.e. technically a valueless information) they should also not be processed any way during the reading (should simply be ignored, like now).
They can, however, be very useful for humans browsing the XML-output produced by XStream. I think, the minor dissonance between the HierarchicalStreamWriter and HierarchicalStreamReader (i.e. the former can handle comments, while the latter can't) would be ignorable in the face of the usefulness of this feature.
Barnabas Bodnar
added a comment - Due to the nature of the comments (i.e. technically a valueless information) they should also not be processed any way during the reading (should simply be ignored, like now).
They can, however, be very useful for humans browsing the XML-output produced by XStream. I think, the minor dissonance between the HierarchicalStreamWriter and HierarchicalStreamReader (i.e. the former can handle comments, while the latter can't) would be ignorable in the face of the usefulness of this feature. 
The main problem is, that comment cannot preserved reading XML. They have simply no representation in the deserialized objects. Therefore it is questionnable if writing of comments should be supported at all.