469384 Improved javadoc for ClasspathPattern

This commit is contained in:
Greg Wilkins 2015-06-24 13:06:59 +10:00
parent 07c81d6ec7
commit 621338f98e
2 changed files with 12 additions and 16 deletions

View File

@ -31,10 +31,16 @@ import org.eclipse.jetty.util.StringUtil;
/**
* Classpath classes list performs sequential pattern matching of a class name
* against an internal array of classpath pattern entries.
*
* When an entry starts with '-' (minus), reverse matching is performed.
* When an entry ends with '.' (period), prefix matching is performed.
*
* A class pattern is a string of one of the forms:<ul>
* <li>'org.package.SomeClass' will match a specific class
* <li>'org.package.' will match a specific package hierarchy
* <li>'-org.package.Classname' excludes a specific class
* <li>'-org.package.' excludes a specific package hierarchy
* <li>Nested classes must be specified with the '$' separator if they
* are to be explicitly included or excluded (eg. org.example.MyClass$NestedClass).
* <li>Nested classes are matched by their containing class. (eg. -org.example.MyClass
* would exclude org.example.MyClass$AnyNestedClass)
* </ul>
* When class is initialized from a classpath pattern string, entries
* in this string should be separated by ':' (semicolon) or ',' (comma).
*/

View File

@ -1191,12 +1191,7 @@ public class WebAppContext extends ServletContextHandler implements WebAppClassL
* Server classes/packages are classes used to implement the server and are hidden
* from the context. If the context needs to load these classes, it must have its
* own copy of them in WEB-INF/lib or WEB-INF/classes.
* A class pattern is a string of one of the forms:<dl>
* <dt>org.package.Classname</dt><dd>Match a specific class</dd>
* <dt>org.package.</dt><dd>Match a specific package hierarchy</dd>
* <dt>-org.package.Classname</dt><dd>Exclude a specific class</dd>
* <dt>-org.package.</dt><dd>Exclude a specific package hierarchy</dd>
* </dl>
* A {@link ClasspathPattern} is used to match the server classes.
* @param serverClasses The serverClasses to set.
*/
public void setServerClasses(String[] serverClasses)
@ -1211,12 +1206,7 @@ public class WebAppContext extends ServletContextHandler implements WebAppClassL
* System classes/packages are classes provided by the JVM and that
* cannot be replaced by classes of the same name from WEB-INF,
* regardless of the value of {@link #setParentLoaderPriority(boolean)}.
* A class pattern is a string of one of the forms:<dl>
* <dt>org.package.Classname</dt><dd>Match a specific class</dd>
* <dt>org.package.</dt><dd>Match a specific package hierarchy</dd>
* <dt>-org.package.Classname</dt><dd>Exclude a specific class</dd>
* <dt>-org.package.</dt><dd>Exclude a specific package hierarchy</dd>
* </dl>
* A {@link ClasspathPattern} is used to match the system classes.
* @param systemClasses The systemClasses to set.
*/
public void setSystemClasses(String[] systemClasses)