Class PersonMitJavadoc

java.lang.Object
PersonMitJavadoc
public class PersonMitJavadoc
extends java.lang.Object
Klasse 'PersonMitJavadoc' dient zur Demonstration sinnvoller API-Dokumentation (API = Application Programming Interface).

Diese Dokumentation soll die Nutzung der Klasse durch andere Programmierer ohne Studium des Source-Codes ermöglichen. Daher sind im besten Falle alle Infos zu:

  • genereller Zweck der Klasse oder Methode
  • Einheiten
  • Gültigkeitsbereiche
  • Sonderbedeutungen bestimmter übergebener und/oder zurückgegebener Werte (null, 0, negativ, ...)
  • Fehlermöglichkeiten samt Reaktion der Methode(n)
  • ...

anzugeben.

Wichtig: (optionale) Zeilenschaltung nach erstem Satz (". <br>"): Leerzeichen nach Punkt ZWINGEND, damit Satz-Ende erkannt wird!
Version:
2020-12-06.v1
Author:
renkin@spengergasse.at

  • Constructor Summary

    Constructors 
    Constructor Description
    PersonMitJavadoc​(java.lang.String name, int gebJahr)
    Konstruktor für Objekte der Klasse 'PersonMitJavadoc'.

  • Method Summary

    Modifier and Type Method Description
    int calcAlter​(int diesesJahr)
    Berechnet ungefähres Alter.
    java.lang.String extractNachname()
    Extrahiert Namensteil nach dem Leerzeichen (EN: space).
    Keine Prüfung auf Vorhandensein des Leerzeichens nötig, da dies bereits im Setter geschieht.
    java.lang.String extractVorname()
    Extrahiert Namensteil vor dem Leerzeichen (EN: space).
    int getGebJahr()
    Getter für Geburtsjahr.
    int getGroesse()
    Getter für Körpergröße.
    java.lang.String getName()
    Getter für Name.
    void setGroesse​(int groesse)
    Setter für Körpergröße.
    void setName​(java.lang.String name)
    Setter für (vollen) Namen.

    Methods inherited from class java.lang.Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PersonMitJavadoc

      public PersonMitJavadoc​(java.lang.String name, int gebJahr)
      Konstruktor für Objekte der Klasse 'PersonMitJavadoc'.

      Extrem einfache Personen-Klasse für Demonstrationszwecke. Es sind nur Konstruktor (mit Parameter), Getter (mit Rückgabewert), Setter (mit Parameter) und eine einzige zusätzliche Methode (mit Parameter UND Rückgabewert) vorhanden.

      Name ist veränderbar, Geburtsjahr fix, als dritte Eigenschaft existiert die (ebenfalls veränderbare) Größe, die zu Beginn auf 'nicht gesetzt' (= -99) steht.

      Parameters:
      name - Details siehe Setter setName(java.lang.String)
      gebJahr - das Geburtsjahr als 4-stellige Zahl (z.B. 1999) zw. 1900 und 2030

  • Method Details

    • setName

      public void setName​(java.lang.String name)
      Setter für (vollen) Namen.
      Parameters:
      name - VOLLER Name im Format "Vorname Nachname" (in dieser Reihenfolge, genau ein Leerzeichen).
      Wenn ein Teil unbekannt, auf '---' setzen.
      Muster für gültige Werte: nicht null, genau 1 Leerzeichen, dieses nicht am Anfang oder Ende. Wenn übergebener Wert ungültig, bleibt der alte

    • setGroesse

      public void setGroesse​(int groesse)
      Setter für Körpergröße.
      Parameters:
      groesse - in cm zwischen 50 und 250. Wenn übergebener Wert ungültig, bleibt der alte

    • getName

      public java.lang.String getName()
      Getter für Name.
      Returns:
      der Name ('--- ---' vor erstem gültigen Setzen)

    • getGebJahr

      public int getGebJahr()
      Getter für Geburtsjahr.
      Returns:
      das Geburtsjahr (-9999 vor erstem gültigen Setzen)

    • getGroesse

      public int getGroesse()
      Getter für Körpergröße.
      Returns:
      Größe in cm (-99 vor erstem gültigen Setzen)

    • extractVorname

      public java.lang.String extractVorname()
      Extrahiert Namensteil vor dem Leerzeichen (EN: space).
      Keine Prüfung auf Vorhandensein des Leerzeichens nötig, da dies bereits im Setter geschieht.
      Returns:
      liefert Vorname ("---" vor erstem gültigen Setzen)

    • extractNachname

      public java.lang.String extractNachname()
      Extrahiert Namensteil nach dem Leerzeichen (EN: space).
      Keine Prüfung auf Vorhandensein des Leerzeichens nötig, da dies bereits im Setter geschieht.
      Returns:
      liefert Nachname ("---" vor erstem gültigen Setzen)

    • calcAlter

      public int calcAlter​(int diesesJahr)
      Berechnet ungefähres Alter.
      Parameters:
      diesesJahr - das Jahr, in dem das jeweilige Alter bestimmt werden soll.
      Gültig zw. 1900 und 2030 (wie Gültigkeitsbereich von Geburtsjahr).
      Returns:
      das ungefähre Alter in Jahren. Bei nicht gültigem 'diesesJahr' oder Geburtsjahr PersonMitJavadoc(java.lang.String, int): -99