Marco Castellani's Library tagged reference → View Popular

A doc comment is written in HTML and must precede a class, field,
constructor or method declaration. It is made up of two parts --
a description followed by block tags. In this example, the block
tags are @param, @return, and
@see.
An @param tag is "required" (by convention) for every parameter,
even when the description is
obvious. The @return tag is required for every method that returns something
other than void, even if it is redundant with the method description.
(Whenever possible, find something non-redundant (ideally, more specific) to use
for the tag comment.)
1 more annotations...
- @param
  (reference page)
  The @param tag is followed by the name (not data type) of the parameter,
  followed by a description of the parameter. By convention, the first noun
  in the description is the data type of the parameter.

16 Feb 09

04 Feb 09

The String class represents character strings. All
string literals in Java programs, such as "abc", are
implemented as instances of this class.
Strings are constant; their values cannot be changed after they
are created.
4 more annotations...
- The class String includes methods for examining
  individual characters of the sequence, for comparing strings, for
  searching strings, for extracting substrings, and for creating a
  copy of a string with all characters translated to uppercase or to
  lowercase.
- The Java language provides special support for the string
  concatenation operator ( + ), and for conversion of
  other objects to strings.
- String[]
  split(String regex)
  
  Splits this string around matches of the given regular expression.
- compareTo
  
  public int compareTo(String anotherString)
  
  Compares two strings lexicographically.
  The comparison is based on the Unicode value of each character in
  the strings.

Reads text from a character-input stream, buffering characters so as to
provide for the efficient reading of characters, arrays, and lines.
In general, each read request made of a Reader causes a corresponding
read request to be made of the underlying character or byte stream. It is
therefore advisable to wrap a BufferedReader around any Reader whose read()
operations may be costly, such as FileReaders and InputStreamReaders.
1 more annotations...
- Reads a line of text. A line is considered to be terminated by any one
  of a line feed ('\n'), a carriage return ('\r'), or a carriage return
  followed immediately by a linefeed.

An ordered collection (also known as a sequence). The user of this
interface has precise control over where in the list each element is
inserted. The user can access elements by their integer index (position in
the list), and search for elements in the list.
Unlike sets, lists typically allow duplicate elements.

Contains the collections framework, legacy collection classes, event model,
date and time facilities, internationalization, and miscellaneous utility
classes (a string tokenizer, a random-number generator, and a bit array).
Collection<E>
2 more annotations...
- The root interface in the collection hierarchy.
- List<E>
  An ordered collection (also known as a sequence).

Provides for system input and output through data streams,
serialization and the file system.
Reads text from a character-input stream, buffering characters so as to
provide for the efficient reading of characters, arrays, and lines.
4 more annotations...
- Writes text to a character-output stream, buffering characters so as to
  provide for the efficient writing of single characters, arrays, and strings.
- An abstract representation of file and directory pathnames.
- Abstract class for reading character streams.
- Abstract class for writing to character streams.

29 Jan 09

26 Jan 09

15 Jan 09

Provides for system input and output through data streams,
serialization and the file system.
Contains the collections framework, legacy collection classes, event model,
date and time facilities, internationalization, and miscellaneous utility
classes (a string tokenizer, a random-number generator, and a bit array).