Die Klasse String

Bei einer Java Entwicklungsumgebung wie Borland JBuilder oder Symantec Café ist die Dokumentation integriert (setzen Sie im Editor den Cursor in einen Klassennamen und drücken Sie F1). Wenn Sie Java von Sun Microsystems haben, sehen Sie auf Ihrer Festplatte nach, in Ordnern wie C:\jdk1.3\docs\index.html. Hier ist eine Kurzversion der Dokumentation für die Klasse String.

    // Konstruktoren
    public String();
    public String(String  value);

    // Methoden
    public char charAt(int  index);
    public String concat(String  str);
    public boolean endsWith(String  suffix);
    public boolean equals(Object  anObject);
    public boolean equalsIgnoreCase(String  anotherString);
    public int indexOf(int  ch);
    public int indexOf(String  str);

    public int length();
    public boolean startsWith(String  prefix);
    public String substring(int  beginIndex, int endIndex);
    public String toLowerCase();
    public String toUpperCase();
    public String trim();

Die Dokumentation führt zuerst die Konstruktoren auf. Danach beschreibt sie die Methoden. Zum Beispiel,

public String concat( String str );
--+--- --+---  --+--  ----+----
  |      |       |        |
  |      |       |        |
  |      |       |        +---- besagt, dass es eine
  |      |       |              Stringreferenz als Parameter geben muss
  |      |       |
  |      |       +----- der Name der Methode
  |      |
  |      +----- die Methode gibt eine Referenz
  |             auf ein neues Stringobjekt zurück
  |
  +----- überall wo Sie ein Stringobjekt haben,
         können Sie diese Methode verwenden

String erster   = "Dempster ";
String letzter  = "Dumpster";
String name     = erster.concat( letzter );