Observatør-observert-teknikken - HighscoreProgram-oppgave

ListListener-grensesnittet må implementers av alle klasser som ønsker å fungere som lyttere for HighscoreList-instanser. Disse registrere seg med HighscoreList sin addListListener-metode og vil siden få beskjed ved at listChanged-metoden kalles hver gang et nytt resultat kommer inn på lista. Argumentene som tas inn er HighscoreList-objektet som ble endret og posisjonen i lista der endringen skjedde.

Klassediagram for HighscoreList, ListListener og ObservableList.

En HighscoreList skal holde styr på heltallsresultater (av typen int/Integer). Lista skal være observerbar ved at den kan registrere lyttere (ListListener-instanser) og si fra til dem når lista blir endret. Lista skal ha en maksimal lengde, som settes i konstruktøren, f.eks. skal en topp 10-liste kunne opprettes med new HighscoreList(10). Nye resultater registreres med metoden addResult(int), som skal finne riktig posisjon og legge resultatet inn (dersom det er godt nok). Dersom lista er for lang, så skal det dårligste resultatet fjernes.

Merk at første argument til listChanged-metoden er av typen ObservableList. Dette er en abstrakt superklasse for HighscoreList kalt ObservableList, som innføres i del 3 og som da skal holde orden på lista. ObservableList vil ha en del generelle metoder som HighscoreList arver og kan bruke. For å kunne kjøre testene for HighscoreList allerede i del 1, så må ObservableList være definert fra starten. Lag derfor en tom ObservableList-klasse og bruk denne som superklasse for HighscoreList.

Her er en oversikt over metoden som må implementeres:

• HighscoreList(int maxSize) - konstruktøren tar inn maks antall resultater som lista skal kunne holde. Denne verdien må brukes av addResult, slik at resultater som er for dårlige kastes.
• size() - returnerer antall elementer i lista, som altså aldri skal overstige maks-antallet
• int getElement(int) - returnerer resultatet i posisjonen angitt av argumentet
• void addResult(int) - registrere et nytt resultat, og dersom resultatet er godt nok til å komme med på lista, så legges det inn på riktig plass. Dersom lista blir for lang, så må dårligste resultat kastes. Alle registrerte lyttere må få beskjed om en evt. endring av lista, inkludert på hvilken posisjon som ble endret.
• addListListener(ListListener) - registrerer en ny lytter
• removeListListener(ListListener) - fjerner en tidligere registrert lytter

Klassediagrammet viser hvordan klassene henger sammen, og vårt forslag til metoder.

Lag en hovedprogramklasse kalt HighscoreProgram, som tester at HighscoreList-klassen din virker som den skal. La den opprette en HighscoreList-instans, lese inn tall fra konsollet (f.eks. med en Scanner og nextInt-metoden) og legge disse inn i lista. Sørg for at HighscoreProgram implementerer ListListener-grensesnittet og registrerer seg som lytter på HighscoreList-instansen. La lyttermetoden listChanged skrive ut informasjon og resultatene i HighscoreList-instansen og posisjonsargumentet, slik at du ser at alt virker som det skal.

Vi foreslår følgende metoder og oppførsel:

• void init() - oppretter en ny HighscoreList og registrerer seg selv (altså HighscoreProgram-instansen) som lytter
• void run() - leser inn tall (resultater) fra konsollet og legger dem til i listen
• void listChanged(ObservableList, int) - observerer endringer i HighscoreList-instansen og skriver ut posisjonsargumentet, samt selve listen, til konsollet

Klassediagrammet viser hvordan klassene henger sammen, og hvor metodene nå er deklarert/implementert. Merk at addElement- og removeElement-metodene er angitt som protected (ruter-symbolet), slik at kun subklasser skal kunne bruke dem.

Den abstrakte superklassen ObservableList skal legges til som en generell superklasse for observerbare lister, som HighscoreList skal arve fra. Denne klassen skal både holde en liste med objekter (Object) og håndtere registrering av lyttere, altså en liste med ListListener-instanse som får beskjed om endringer i lista (slik at lista dermed er observerbar). Dette betyr at ObservableList overtar håndtering av både resultater og lyttere fra HighscoreList-klassen. For å gjøre ObservableList mer generell og gjenbrukbar, så lar vi den håndtere Object-instanser (heller enn Integer). Samtidig deklarerer den en abstrakt metode acceptsElement, som subklasser må redefinere for å bestemme hva slags objekter det skal være lov å legge inn. HighscoreList vil f.eks måtte redefinere den slik at bare Integer-objekter aksepteres.

ObservableList skal ha følgende metoder (noen er altså overtatt fra HighscoreList):

• int size() - returnerer antall elementer i lista
• Object getElement(int) - returnerer elementet i posisjonen angitt av argumentet
• abstract boolean acceptsElement(Object) - returnerer hvorvidt subklassen aksepterer at objektet legges inn i lista (f.eks. aksepterer HighscoreList kun Integer-objekter).
• void addElement(int, Object) - legger til et element på posisjonen angitt av argumentet, men bare dersom det aksepteres som element. Dersom elementet ikke aksepteres, så skal IllegalArgumentException utløses. Dersom posisjonen er ulovlig så skal IndexOutOfBoundsException utløses.
• void addElement(Object) - legger til et element bakerst i lista, men bare dersom det aksepteres som element. Dersom elementet ikke aksepteres, så skal IllegalArgumentException utløses.
• void removeElement(int) - fjerner elementet på posisjonen angitt av argumentet. Dersom posisjonen er ulovlig så skal IndexOutOfBoundsException utløses.

HighscoreList skal endres slik at den i størst mulig grad bruker metodene som arves fra ObservableList, men forøvrig ikke endrer oppførsel. Kjør hovedprogramklassen HighscoreProgram for å sjekke at dette faktisk stemmer.