-
- All Superinterfaces:
Tag
@Deprecated(since="9", forRemoval=true) public interface SeeTag extends Tag
Deprecated, for removal: This API element is subject to removal in a future version.The declarations in this package have been superseded by those in the packagejdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.Represents a user-defined cross-reference to related documentation. The tag can reference a package, class or member, or can hold plain text. (The plain text might be a reference to something not online, such as a printed book, or be a hard-coded HTML link.) The reference can either be inline with the comment, using{@link}, or a separate block comment, using@see. Methodname()returns "@link" (no curly braces) or "@see", depending on the tag. Methodkind()returns "@see" for both tags.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Stringlabel()Deprecated, for removal: This API element is subject to removal in a future version.Get the label of the@seetag.ClassDocreferencedClass()Deprecated, for removal: This API element is subject to removal in a future version.Get the class doc referenced by the class name part of @see.StringreferencedClassName()Deprecated, for removal: This API element is subject to removal in a future version.Get the class or interface name of the@seereference.MemberDocreferencedMember()Deprecated, for removal: This API element is subject to removal in a future version.Get the member doc for the field, constructor or method referenced by@see.StringreferencedMemberName()Deprecated, for removal: This API element is subject to removal in a future version.Get the field, constructor or method substring of the@seereference.PackageDocreferencedPackage()Deprecated, for removal: This API element is subject to removal in a future version.Get the package doc when@seereferences only a package.-
Methods declared in interface com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString
-
-
-
-
Method Detail
-
label
String label()
Deprecated, for removal: This API element is subject to removal in a future version.Get the label of the@seetag. Return null if no label is present. For example, for:
return "the trim method".@see String#trim() the trim method- Returns:
- "the trim method".
-
referencedPackage
PackageDoc referencedPackage()
Deprecated, for removal: This API element is subject to removal in a future version.Get the package doc when@seereferences only a package. Return null if the package cannot be found, or if@seereferences any other element (class, interface, field, constructor, method) or non-element. For example, for:
return the@see java.langPackageDocforjava.lang.- Returns:
- the
PackageDocforjava.lang.
-
referencedClassName
String referencedClassName()
Deprecated, for removal: This API element is subject to removal in a future version.Get the class or interface name of the@seereference. The name is fully qualified if the name specified in the original@seetag was fully qualified, or if the class or interface can be found; otherwise it is unqualified. If@seereferences only a package name, then return the package name instead. For example, for:
return "java.lang.String". For "@see String#valueOf(java.lang.Object)@see java.lang", return "java.lang". Return null if@seereferences a non-element, such as@see <a href="java.sun.com">.- Returns:
- null if
@seereferences a non-element, such as@see <a href="java.sun.com">.
-
referencedClass
ClassDoc referencedClass()
Deprecated, for removal: This API element is subject to removal in a future version.Get the class doc referenced by the class name part of @see. Return null if the class cannot be found. For example, for:
return the@see String#valueOf(java.lang.Object)ClassDocforjava.lang.String.- Returns:
- the
ClassDocforjava.lang.String.
-
referencedMemberName
String referencedMemberName()
Deprecated, for removal: This API element is subject to removal in a future version.Get the field, constructor or method substring of the@seereference. Return null if the reference is to any other element or to any non-element. References to member classes (nested classes) return null. For example, for:
return "startsWith(String)".@see String#startsWith(String)- Returns:
- "startsWith(String)".
-
referencedMember
MemberDoc referencedMember()
Deprecated, for removal: This API element is subject to removal in a future version.Get the member doc for the field, constructor or method referenced by@see. Return null if the member cannot be found or if the reference is to any other element or to any non-element. References to member classes (nested classes) return null. For example, for:
return the@see String#startsWith(java.lang.String)MethodDocforstartsWith.- Returns:
- the
MethodDocforstartsWith.
-
-