Template talk:Javadoc:SE
From Wikipedia, the free encyclopedia
Do not subst this template. This template is intended to link to the current Javadoc pages for the most recent release of Java SE. If you substitute the template using {{subst:Javadoc:SE|...}} then the link will not be updated when the root URL for this page is updated.
[edit] Usage
These are the common forms of usage for this template:
-
Type this To get this {{Javadoc:SE}} Java SE 6 API Javadocs {{Javadoc:SE|java/lang|Object}} Object{{Javadoc:SE|java/lang|Object|clone()}} Object.clone(){{Javadoc:SE|package=java.lang|java/lang}} java.lang{{Javadoc:SE|package=java.lang|java/lang|Object}} java.lang.Object{{Javadoc:SE|package=java.lang|java/lang|Object|clone()}} java.lang.Object.clone()
In the above example, clone() can be any member documented in the Javadoc that isn't a class or interface, so {{Javadoc:SE|java/lang|System|out}} produces System.out. For a class or interface member, the class name is OuterClass.InnerClass, so {{Javadoc:SE|java/lang|Character.Subset}} produces Character.Subset.
The Javadoc URLs don't include the generic parameterized types. To get the type parameters to display, specify a class and/or member parameter to the template to override the name of the displayed class and/or member name. Note that the parameterized type notation uses angle brackets (< and >), so type parameter names that match HTML markup tags need to use the character encodings < for < and > for >.
-
Type this To get this {{Javadoc:SE|class=Class<T>|java/lang|Class}} Class<T>{{Javadoc:SE|class=Class<T>|
member=asSubclass(Class<U>)|
java/lang|Class|asSubclass(java.lang.Class)}}Class<T>.asSubclass(Class<U>){{Javadoc:SE|package=java.lang|class=Class<T>|
java/lang|Class}}java.lang.Class<T>{{Javadoc:SE|package=java.lang|class=Class<T>|
member=asSubclass(Class<U>)|
java/lang|Class|asSubclass(java.lang.Class)}}java.lang.Class<T>.asSubclass(Class<U>)
The URL to a method uses the fully-qualified path name of the parameter types. The member parameter can be used to use the simple type name of method parameters, as shown in the preceding table, or even to eliminate the parameters entirely.
Finally, if none of the above work for the displayed text, supplying a name parameter allows the entire package/class/member name displayed to be replaced. (However, the name parameter won't override the text displayed when using the {{Javadoc:SE}} form.)
-
Type this To get this {{Javadoc:SE|name=out|java/lang|System|out}} out
[edit] Issues
- Some versions of Javadoc, such as the version used to create the current Javadoc API pages as J2SE 5.0 and J2EE 1.4, put spaces between the parameter names in the anchor tags used to link to the definitions of members. Unfortuneately, that means that it isn't possible to have an outside link directly index any method with two or more parameters. Links to methods with two or more parameters will link to the top of the page.
- Including square brackets ([, ]) in the parameter types of method or constructor member arguments seems to break the template. Instead, replace square brackets with their numeric character reference escape codes, [ and ], like this:
-
-
Type this To get this {{Javadoc:SE|java/util|Arrays|sort(java.lang.Object[])}} Arrays.sort(java.lang.Object[]){{Javadoc:SE | member=sort(Object[])|java/util|Arrays|sort(java.lang.Object[])}} Arrays.sort(Object[])
-
[edit] Java 6
This should be updated for the Java 6 docs http://java.sun.com/javase/6/docs/api/ --Spoon! 00:16, 14 December 2006 (UTC)
