klute 02/04/25 22:58:00
Modified: src/java/org/apache/poi/hpsf SummaryInformation.java
Log:
Comment added.
Revision Changes Path
1.2 +18 -3 jakarta-poi/src/java/org/apache/poi/hpsf/SummaryInformation.java
Index: SummaryInformation.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hpsf/SummaryInformation.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SummaryInformation.java 14 Feb 2002 04:00:59 -0000 1.1
+++ SummaryInformation.java 26 Apr 2002 05:58:00 -0000 1.2
@@ -69,7 +69,7 @@
* @see DocumentSummaryInformation
*
* @author Rainer Klute ([EMAIL PROTECTED])
- * @version $Id: SummaryInformation.java,v 1.1 2002/02/14 04:00:59 mjohnson Exp $
+ * @version $Id: SummaryInformation.java,v 1.2 2002/04/26 05:58:00 klute Exp $
* @since 2002-02-09
*/
public class SummaryInformation extends SpecialPropertySet
@@ -279,8 +279,23 @@
/**
- * <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()
{
