mrglavas 2004/03/22 17:23:41
Modified: java/src/org/apache/xerces/util SecurityManager.java
Log:
Fixing javadoc. It wasn't being generated for the methods
because we were using the wrong style of comments.
Revision Changes Path
1.5 +44 -19 xml-xerces/java/src/org/apache/xerces/util/SecurityManager.java
Index: SecurityManager.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/util/SecurityManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SecurityManager.java 24 Feb 2004 23:15:53 -0000 1.4
+++ SecurityManager.java 23 Mar 2004 01:23:41 -0000 1.5
@@ -40,52 +40,77 @@
// Constants
//
- // default value for entity expansion limit
+ /** Default value for entity expansion limit. **/
private final static int DEFAULT_ENTITY_EXPANSION_LIMIT = 100000;
- //default value of number of nodes created
+ /** Default value of number of nodes created. **/
private final static int DEFAULT_MAX_OCCUR_NODE_LIMIT = 3000;
//
// Data
//
- /** entity expansion limit */
+ /** Entity expansion limit. **/
private int entityExpansionLimit;
+
+ /** W3C XML Schema maxOccurs limit. **/
private int maxOccurLimit;
- // default constructor. Establishes default values for
- // all known security holes.
+ /**
+ * Default constructor. Establishes default values
+ * for known security vulnerabilities.
+ */
public SecurityManager() {
entityExpansionLimit = DEFAULT_ENTITY_EXPANSION_LIMIT;
maxOccurLimit = DEFAULT_MAX_OCCUR_NODE_LIMIT ;
}
- // set the number of entity expansions that the
- // parser should permit in a document
+ /**
+ * <p>Sets the number of entity expansions that the
+ * parser should permit in a document.</p>
+ *
+ * @param limit the number of entity expansions
+ * permitted in a document
+ */
public void setEntityExpansionLimit(int limit) {
entityExpansionLimit = limit;
}
- // return the number of entity expansions that the
- // parser permits in a document
+ /**
+ * <p>Returns the number of entity expansions
+ * that the parser permits in a document.</p>
+ *
+ * @return the number of entity expansions
+ * permitted in a document
+ */
public int getEntityExpansionLimit() {
return entityExpansionLimit;
}
- //sets the limit of the number of content model nodes that may be created when
building
- // a grammar for a schema that contains maxOccurs attributes with values
- // other than "unbounded"
+ /**
+ * <p>Sets the limit of the number of content model nodes
+ * that may be created when building a grammar for a W3C
+ * XML Schema that contains maxOccurs attributes with values
+ * other than "unbounded".</p>
+ *
+ * @param limit the maximum value for maxOccurs other
+ * than "unbounded"
+ */
public void setMaxOccurNodeLimit(int limit){
- maxOccurLimit = limit ;
+ maxOccurLimit = limit;
}
-
- //sets the limit of the number of content model nodes that may be created when
building
- // a grammar for a schema that contains maxOccurs attributes with values
- // other than "unbounded"
+ /**
+ * <p>Returns the limit of the number of content model nodes
+ * that may be created when building a grammar for a W3C
+ * XML Schema that contains maxOccurs attributes with values
+ * other than "unbounded".</p>
+ *
+ * @return the maximum value for maxOccurs other
+ * than "unbounded"
+ */
public int getMaxOccurNodeLimit(){
- return maxOccurLimit ;
+ return maxOccurLimit;
}
} // class SecurityManager
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
