Movatterモバイル変換

Method Summary

Method Detail

• commentText

  String commentText()

  Deprecated. 
  Return the text of the comment for this doc item. Tags have been removed.

  Returns:

  the text of the comment for this doc item.

• tags

  Tag[] tags()

  Deprecated. 
  Return all tags in this Doc item.

  Returns:

  an array ofTag objects containing all tags on this Doc item.

• tags

  Tag[] tags(String tagname)

  Deprecated. 
  Return tags of the specifiedkind in this Doc item. For example, if 'tagname' has value "@serial", all tags in this Doc item of kind "@serial" will be returned.

  Parameters:

  tagname - name of the tag kind to search for.

  Returns:

  an array of Tag containing all tags whose 'kind()' matches 'tagname'.

• seeTags

  SeeTag[] seeTags()

  Deprecated. 
  Return the see also tags in this Doc item.

  Returns:

  an array of SeeTag containing all @see tags.

• inlineTags

  Tag[] inlineTags()

  Deprecated. 
  Return comment as an array of tags. Includes inline tags (i.e. {@linkreference} tags) but not block tags. Each section of plain text is represented as aTag ofkind "Text". Inline tags are represented as aSeeTag of kind "@see" and name "@link".

  Returns:

  an array ofTags representing the comment

• firstSentenceTags

  Tag[] firstSentenceTags()

  Deprecated. 
  Return the first sentence of the comment as an array of tags. Includes inline tags (i.e. {@linkreference} tags) but not block tags. Each section of plain text is represented as aTag ofkind "Text". Inline tags are represented as aSeeTag of kind "@see" and name "@link".

  If the locale is English language, the first sentence is determined by the rules described in the Java Language Specification (first version): "This sentence ends at the first period that is followed by a blank, tab, or line terminator or at the first tagline.", in addition a line will be terminated by block HTML tags: <p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre> or </pre>. If the locale is not English, the sentence end will be determined byBreakIterator.getSentenceInstance(Locale).

  Returns:

  an array ofTags representing the first sentence of the comment

• getRawCommentText

  String getRawCommentText()

  Deprecated. 
  Return the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.

  Returns:

  the full unprocessed text of the comment.

• setRawCommentText

  void setRawCommentText(String rawDocumentation)

  Deprecated. 
  Set the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.

  Parameters:

  rawDocumentation - A String containing the full unprocessed text of the comment.

• name

  String name()

  Deprecated. 
  Returns the non-qualified name of this Doc item.

  Returns:

  the name

• compareTo

  int compareTo(Object obj)

  Deprecated. 
  Compares this doc object with the specified object for order. Returns a negative integer, zero, or a positive integer as this doc object is less than, equal to, or greater than the given object.

  This method satisfies theComparable interface.

  Specified by:

  compareTo in interface Comparable<Object>

  Parameters:

  obj - theObject to be compared.

  Returns:

  a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.

  Throws:

  ClassCastException - the specified Object's type prevents it from being compared to this Object.

• isField

  boolean isField()

  Deprecated. 
  Is this Doc item a field (but not an enum constant)?

  Returns:

  true if it represents a field

• isEnumConstant

  boolean isEnumConstant()

  Deprecated. 
  Is this Doc item an enum constant?

  Returns:

  true if it represents an enum constant

  Since:

  1.5

• isConstructor

  boolean isConstructor()

  Deprecated. 
  Is this Doc item a constructor?

  Returns:

  true if it represents a constructor

• isMethod

  boolean isMethod()

  Deprecated. 
  Is this Doc item a method (but not a constructor or annotation type element)?

  Returns:

  true if it represents a method

• isAnnotationTypeElement

  boolean isAnnotationTypeElement()

  Deprecated. 
  Is this Doc item an annotation type element?

  Returns:

  true if it represents an annotation type element

  Since:

  1.5

• isInterface

  boolean isInterface()

  Deprecated. 
  Is this Doc item an interface (but not an annotation type)?

  Returns:

  true if it represents an interface

• isException

  boolean isException()

  Deprecated. 
  Is this Doc item an exception class?

  Returns:

  true if it represents an exception

• isError

  boolean isError()

  Deprecated. 
  Is this Doc item an error class?

  Returns:

  true if it represents a error

• isEnum

  boolean isEnum()

  Deprecated. 
  Is this Doc item an enum type?

  Returns:

  true if it represents an enum type

  Since:

  1.5

• isAnnotationType

  boolean isAnnotationType()

  Deprecated. 
  Is this Doc item an annotation type?

  Returns:

  true if it represents an annotation type

  Since:

  1.5

• isOrdinaryClass

  boolean isOrdinaryClass()

  Deprecated. 
  Is this Doc item anordinary class? (i.e. not an interface, annotation type, enum, exception, or error)?

  Returns:

  true if it represents an ordinary class

• isClass

  boolean isClass()

  Deprecated. 
  Is this Doc item aclass (and not an interface or annotation type)? This includes ordinary classes, enums, errors and exceptions.

  Returns:

  true if it represents a class

• isIncluded

  boolean isIncluded()

  Deprecated. 
  Return true if this Doc item isincluded in the result set.

  Returns:

  true if this Doc item isincluded in the result set.

• position

  SourcePosition position()

  Deprecated. 
  Return the source position of the first line of the corresponding declaration, or null if no position is available. A default constructor returns null because it has no location in the source file.

  Returns:

  the source positino of the first line of the corresponding declaration, or null if no position is available. A default constructor returns null because it has no location in the source file.

  Since:

  1.4