Comment added.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352488 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rainer Klute 2002-04-26 05:58:00 +00:00
parent 01a123cb98
commit f1fad72ac4
1 changed files with 17 additions and 2 deletions

View File

@ -279,8 +279,23 @@ public class SummaryInformation extends SpecialPropertySet
/**
* <p>Returns the stream's security field or 0 if the {@link
* SummaryInformation} does not contain a security field.</p>
* <p>Returns one of the following values:</p>
*
* <ul>
*
* <li><p>0 if the {@link SummaryInformation} does not contain a
* security field or if there is no security on the document. Use
* {@link #wasNull} to distinguish between the two cases!</p></li>
*
* <li><p>1 if the document is password protected</p></li>
*
* <li><p>2 if the document is read-only recommended</p></li>
*
* <li><p>4 if the document is read-only enforced</p></li>
*
* <li><p>8 if the document is locked for annotations</p></li>
*
* </ul>
*/
public int getSecurity()
{