add some javadocs to Data#getDocument

This commit is contained in:
javanna 2015-11-20 18:01:27 +01:00 committed by Luca Cavanna
parent be3e913349
commit bb298ed27a
1 changed files with 5 additions and 0 deletions

View File

@ -181,6 +181,11 @@ public final class Data {
return id;
}
/**
* Returns the document. Should be used only for reading. Any change made to the returned map will
* not be reflected to the modified flag. Modify the document instead using {@link #setPropertyValue(String, Object)}
* and {@link #removeProperty(String)}
*/
public Map<String, Object> getDocument() {
return document;
}