2.6 Luokista ja olioista

Java-kielessä luokka (class) on hyvin keskeinen käsite: Tavallinen ohjelma, sovellus, toteutetaan luokkana, www-sivuilla toimivat sovelmat ovat luokkia, ohjelmakirjastoja kerätään luokiksi, ... Luokkien välille voidaan muodostaa ns. luokkahierarkioita ns. periytymisen avulla, ... Luokkahierarkioita voidaan käyttää ongelman mallintamiseen ja toisaalta varsinaisen ohjelmistoprojektin hallintaan.

Tässä luvussa tutustutaan luokan määrittelemiseen ja luokan ilmentymän, ns olion (object), luontiin ja käyttöön.

• Luokista ja olioista
• Luokan määrittely
• Olion luonti
  • Esimerkki luennolla 3.10.2002
• Luokan rakenteesta
• Viittaus "tähän olioon": this
• Esimerkkitehtävä kapseloinnista 11.10.2004
• Esimerkkiluokka: PikkuVarasto
• Olio parametrina ja metodin palauttamana arvona

Luokista ja olioista

Luokka määrittelee jonkin toiminnallisuuden, "koneen piirustuksen". Määrittelyn perusteella voidaan sitten luoda luokan ilmentymiä, olioita, "koneita", jotka toteuttavat tuon toiminnallisuuden.

Ajatus on, että "koneen" toiminnan yksityiskohdat piilotetaan käyttäjältä, siis ohjelmalta (ja ohjelmoijalta!), joka käyttää luokan ilmentymiä. "Koneen" ohjelmoijalla ja käyttäjällä on yhteinen sopimus siitä, miten konetta käytetään: so. millaisia "mittareita", "nappuloita", "vipuja" yms. koneessa on ja mitä ne tarkoittavat. Mutta muuten luokan ohjelmoijan ja luokkaa käyttävän ohjelman laatijan ei tarvitse (eikä pidä) tietää toistensa tekemisistä. Sama henkilö voi toki toimia molemmissa tehtävissä!

Huom: Nuo "mittarit", "nappulat" ja "vivut" toteutetaan luokan julkisina (public) metodeina! (Tämä on osatotuus!)

Tällaisia luokkia voidaan kutsua abstrakteiksi tietotyypeiksi: luokan ilmentymän, olion, käyttäjä tietää, miten oliota käytetään, mutta hän ei tiedä miten olio on toteutettu. Luokan toteuttaja ei puolestaan välttämättä tiedä, mihin luokkaa käytetään, hän vain toteuttaa sovitunlaisen välineen.

Tässä on kyseessä yksi menetelmä "unohtaa järjestelmällisesti" yksityiskohtia, jotta voitaisiin hallita isompia ongelmia kuin oikeastaan osataan. Menettelyllä on myös vaikutuksia ohjelman siirrettävyyteen, luotettavuuteen ja olemassaolevien ohjelmien uudelleenkäyttöön.

Näin käytettyinä luokat ovat tyyppejä siinä kuin jo tutuksi tulleet int, double, boolean ja String. On siis mahdollista määritellä muuttujia, joiden tyyppi on jokin itse määritelty luokka; olioita voi sijoittaa tuollaisten muuttujien arvoksi, olioita voi välittää parametreina, arvon palauttava metodi voi palauttaa olion, jonka tyyppi on jokin oma luokka... Jo edellä on käytetty String-tyyppisiä olioita eli String-luokan ilmentymiä tähän tapaan!

Luokan määrittely

public class Sovellus {

  private static void metodi1(...) {
    ...
  }

  private static int metodi2(...) {
    ...
  }
  ...

  public static void main(String[] args) {
    ...
  }
}

Nyt ryhdymme laatimaan sellaisia luokkia, jotka voidaan ymmärtää "koneen piirustuksiksi", tietyn käyttäytymisen toteutuksiksi.

Luokassa voidaan metodien lisäksi määritellä muuttujia (eli kenttiä eli attribuutteja) (rakkaalla lapsella on monta nimeä). Nämä muuttujat esittävät "koneen" sisäistä tilaa (vrt. algoritmin tila luvussa 1.1).

Muuttujien arvoja käsitellään luokan metodien avulla. Metodien muuttujista poiketen luokan muuttujat ovat olemassa myös silloin, kun mitään luokan metodia ei olla suorittamassa. (Metodien muuttujista poiketen luokan muuttujilla on myös oletusalkuarvot, esim. 0, 0.0, false, null. Näistä myöhemmin.)

Esimerkki: Johonkin tarkoitukseen tarvitaan välinettä, jolla voi läpikäydä kuukausien numeroita 1, 2, 3, ... 12. Ehkäpä ohjelma simuloi ajan kulumista vuodesta toiseen kuukausi kerrallaan?

"Koneeseen" halutaan seuraavat "kahvat ja namiskuukkelit":

• väline "koneen käynnistämiseen", aloituskuukauden numeroksi halutaan 1
• väline meneillään olevan kuukauden kysymiseen
• väline, jolla voidaan edetä seuraavaan kuukauteen (lukua 12 seuraa siis luku 1!)

KuuLaskuri.java:

public class KuuLaskuri {

   private int kuu;   // sallitut arvot 1,..12

   // ----- konstruktori: -------

   public KuuLaskuri() {
     kuu = 1;
   }

  // ----- aksessorit: -----------

  public int moneskoKuu() {
    return kuu;
  }

  public void seuraavaKuu() {
    ++kuu;
    if (kuu == 13)
      kuu = 1;
  }
}

   private int kuu;

Luokassa on väline, konstruktori (constructor), jolla luokan ilmentymä eli olio luodaan. Konstruktori voi mm. asettaa luokan kentille alkuarvoja:

   public KuuLaskuri() {
     kuu = 1;
   }

KuuLaskuri-luokan konstruktori siis asettaa kentän kuu arvoksi luvun 1 aina kun luokan ilmentymä luodaan. (Ilmentymiä voi siis samaan aikaan olla useita.)

Luokalla voi olla useampiakin konstruktoreita erilaisin parametrein. Konstruktoreita voidaan siis kuormittaa.

Aksessori (accessor) on konstruktoria epämääräisempi käsite: Sillä tarkoitetaan metodia, jolla luokan private-kenttiä tutkitaan tai muutetaan. (Yleensä luokan kaikki metodit tavalla tai toisella käyttävät luokan kenttiä. Rajanveto aksessorin ja "muun työkalun" välillä on häilyvä.)

Metodi

  public int moneskoKuu() {
    return kuu;
  }

  public void seuraavaKuu() {
    ++kuu;
    if (kuu == 13)
      kuu = 1;
  }

Metodit on määritelty julkisiksi, koska juuri niillä luokan ilmentymiä käytetään, juuri ne ovat niitä "kahvoja ja namiskuukkeleita", joilla konetta käytetään! Mitään muuta keinoa luokan käyttäjällä ei ole käsitellä kenttää kuu!

Tässä esimerkissä käyttäjältä kätketty "tietorakenne" on äärimmäisen yksinkertainen, pelkkä yksittäinen muuttuja. Mutta samaan tapaan voidaan kätkeä myös monimutkaisempien tietorakenteiden toteutukset luokan käyttäjältä. Käyttäjä tuntee luokasta vain public-metodeiden nimet ja merkitykset. Hän ei mitenkään muuten pääse käsiksi tietorakenteen konkreettiseen toteutukseen. Siksi näin ohjelmoitua luokkaa voidaan kutsua "abstraktiksi tietotyypiksi".

Vaikka esimerkkiluokka saattaa näyttää käyttökelvottoman yksinkertaiselta, se tarjoaa erään palvelun, jota ei saataisi, jos käytettäisiin tavallisia int-tyyppisiä muuttujia kuukausien läpikäyntiin: tuon luokan ilmentymä ei voi koskaan esittää mitään muuta lukuarvoa kuin kelvollista kuukauden numeroa ja eteneminen 12:sta 1:een on luokan käyttäjän kannalta automaattista! Näin vältytään ohjelmointivirheeltä ainakin tässä yksityiskohdassa!

Olion luonti

Luokan ilmentymä (instance of a class) eli olio (object) luodaan operaatiolla new:

   new KuuLaskuri()

Luokka KuuLaskuri on tyyppinimi siinä kuin vaikkapa jo tuttu String-luokka. On siis mahdollista määritellä muuttujia, joiden tyyppi on KuuLaskuri:

   KuuLaskuri tamaKuu;

Määrittely

   KuuLaskuri tuoKuu = new KuuLaskuri();

Huom: Vaikka olioita käsitellään aina viitteiden avulla, useimmiten viitteitä ei tarvitse ajatella. Usein on tapana sanoa "muuttujan arvona on olio" vaikka tarkoitetaan, että muuttujan arvona on viite olioon. Näin menetellään tälläkin kurssilla:

Nyt tätä tuoKuu-muuttujan arvona olevaa oliota voidaan käyttää KuuLaskuri-luokan tarjoamin julkisin metodein:

   int i = tuoKuu.moneskoKuu(); // i saa arvon 1

   tuoKuu.seuraavaKuu();        // kuukausi kasvaa yhdellä

   System.out.println(tuoKuu.moneskoKuu());
                                // tulostetaan arvo 2

   tamaKuu = tuoKuu;   // tamaKuu VIITTAA SAMAAN OLIOON
                       // kuin muuttuja tuoKuu! Tässä siis
                       // kopioidaan viite, ei oliota!

    olio.metodi(parametrit)

Esimerkkiohjelma (KuuLaskuriTesti.java):

public class KuuLaskuriTesti {

  public static void main (String[] args){

     KuuLaskuri tamaKuu;     
     KuuLaskuri tuoKuu = new KuuLaskuri();

     // käydään läpi 27 kuukautta:

     System.out.println("Kaksikymmentäseitsemän kuukautta:");
     for (int i=0; i<27; ++i){
       System.out.print(tuoKuu.moneskoKuu()+" ");
       tuoKuu.seuraavaKuu();
     }
     System.out.println();

     // kopioidaan viite, ei oliota:

     tamaKuu = tuoKuu;

     System.out.println("tuoKuun:n arvo on nyt "+tuoKuu.moneskoKuu());
     System.out.println("tamaKuun:n arvo on nyt "+tamaKuu.moneskoKuu());

     // edetään seuraavaan kuukauteen, myös tuoKuu etenee,
     // koska muuttujat viittaavat SAMAAN olioon:

     tamaKuu.seuraavaKuu();

     System.out.println("tuoKuun:n arvo on nyt "+tuoKuu.moneskoKuu());
     System.out.println("tamaKuun:n arvo on nyt "+tamaKuu.moneskoKuu());

     // luodaan kaksi uutta KuuLaskuri-oliota, vanhaan ei jää
     // enää viitteitä, se jää roskienkerääjän hoideltavaksi:

     tamaKuu = new KuuLaskuri();
     tuoKuu  = new KuuLaskuri();

     // edistetään tamaKuu:n osoittamaa oliota kahdesti:

     tamaKuu.seuraavaKuu();
     tamaKuu.seuraavaKuu();

     // tulostetaan 15 peräkkäistä kuukauden numeroa MOLEMMISTA
     // olioista:

     System.out.println("Viisitoista kuukautta rinnakkain:");
     for (int i=0; i<15; ++i){
       System.out.println(tamaKuu.moneskoKuu()+"\t"+ 
                          tuoKuu.moneskoKuu());
       tamaKuu.seuraavaKuu();
       tuoKuu.seuraavaKuu();
     }
  }
}

Esimerkki luennolla 3.10.2002

Toki voisi ohjelmoida algoritminpätkän, joka tutkii, mitä kuuta toinen laskuri osoittaa, ja pyöritellä sitten ensimmäistä seuraavaKuu()-metodilla, kunnes kuut ovat samat.

Mutta jos tuo operaatio olisi tavallinen, KuuLaskurin määrittelyä voisi täydentää seuraavasti:

public class KuuLaskuri {
  private int kuu;   // sallitut arvot 1,..12
  public KuuLaskuri() { ...
  public int moneskoKuu() {...
  public void seuraavaKuu() {...

  public void asetaSamaksi(KuuLaskuri tämänKanssa) {
    kuu = tämänKanssa.moneskoKuu();
  }
}

   tamaKuu = new KuuLaskuri();
   tuoKuu  = new KuuLaskuri();

   for (int i=0; i<6; ++i)
     tamaKuu.seuraavaKuu();

   // tamaKuu.moneskoKuu()  on nyt 6
   // tuoKuu.moneskoKuu()   on nyt 1

   tuoKuu.asetaSamaksi(tamaKuu);

   // molemmat ovat nyt 6!

Luokan rakenteesta

public class Kone {

  // koneen sisäinen rakenne eli ulkopuolisilta
  // piilotettu tietorakenne:

  private int i;
  private boolean b;
  private double d;
  private String s;
  ...

  // luokan KONSTRUKTORIT, metodit, joilla kukin luokan 
  // ilmentymä eli olio asetetaan alkutilaan; "koneen 
  // rakentaminen":

  public Kone() {
    ...
  }

  public Kone(int a) {  // konstruktoreita voi kuormittaa!
    ...
  }

  public Kone(String b, double c) {
    ...
  }
  ...

  // luokan AKSESSORIT, julkiset metodit, joilla piilossa
  // pidetyn tietorakenteen tilaa voi tutkia ja muuttaa,
  // "koneen kahvat ja namiskuukkelit":

  public int annaI() {
    return i;
  }

  public void asetaI(int arvo) {
    i = arvo;
  }
  ...
 
  public void teeJotain() {
    i = ...;
    s = ...;
    ...
  }

  public void teeJotain(String jono) {  // kuormitetaan!
    i = ...;
    s = ...;
    ...
  }

  public double hmmTulo() {
    ...
    return ...;
  }
  ...

  // luokan muut metodit Kone-olioiden käsittelyyn:

  public void tulostaTila() {
    System.out.println(...);
    ...
  }

  public int laskeSitaSunTata(...) {
    ...
  }
  ...
  
  // apuvälineitä muiden metodien toteuttamiseen, VAIN
  // LUOKAN OMAAN KÄYTTÖÖN:

  private void metodi1(...) {
    ...
  }

  private static void metodi2(...) {
    ...
  }

  private int metodi3(...) {
    ...
  }
  ...

}

Viittaus "tähän olioon": this

Luokan ohjelmoija voi viitata "juuri tähän ilmentymään" ilmauksella this. Luokka KuuLaskuri voidaan ohjelmoida seuraavasti:

public class KuuLaskuri {

   private int kuu;   // sallitut arvot 1,..12

   // ----- konstruktori: -------

   public KuuLaskuri() {
     this.kuu = 1;
   }

  // ----- aksessorit: -----------

  public int moneskoKuu() {
    return this.kuu;
  }

  public void seuraavaKuu() {
    ++this.kuu;
    if (this.kuu == 13)
      this.kuu = 1;
  }
}

Esimerkkitehtävä kapseloinnista 11.10.2004

• [Vaikka tehtävä on pitkä, älä masennu, ratkaisu on paljon lyhyempi!]
  Kokokonaislukutyyppiä on tietenkin järkevää käyttää sellaisenaan ohjelmia laadittaessa. Harjoituksen vuoksi laaditaan kuitenkin luokka Intti, joka kätkee kokonaisluvun esityksen käyttäjältä ja tarjoaa vain konstruktoreita ja aksessoreita lukuarvon luontiin ja käsittelyyn:

  public class Intti {
  
    private int muuttuja;
    //------------------------------
    public Intti() {
      muuttuja = 0;
    }
    public Intti(int arvo) {
      muuttuja = arvo;
    }
    //------------------------------
    public int arvo() {
      return muuttuja;
    }
    public void sijoita(int arvo) {
      muuttuja = arvo;
    }
  }
  

  Luokkaa voi käyttää vaikkapa seuraavasti (oikealla näkyy, miten asia tehdään tavalliseen tapaan):

  Intti i = new Intti();         // int i = 0;
  Intti j = new Intti(7);        // int j = 7;
  
  System.out.println(i.arvo());  // System.out.println(i);
  System.out.println(j.arvo());  // System.out.println(j);
  
  i.sijoita(22);                 // i = 22;
  j.sijoita(j.arvo()+1);         // j = j + 1;
  
  System.out.println(i.arvo());  // System.out.println(i);
  System.out.println(j.arvo());  // System.out.println(j);
  
  i.sijoita(i.arvo()+j.arvo());  // i = i + j;
  j.sijoita(i.arvo()*2);         // j = i * 2;
  
  System.out.println(i.arvo());  // System.out.println(i);
  System.out.println(j.arvo());  // System.out.println(j);
  

  Täydennä luokkaa metodein:
  • plusPlus() kasvattaa yhdellä; esim. i.plusPlus() vastaa lausetta ++i
  • minusMinus() vähentää yhdellä; esim. i.minusMinus() vastaa lausetta --i
  • kasvata(int kasvatus) vastaa kasvatuslausetta; esim. i.kasvata(a) vastaa lausetta i += a
  • vahenna(int vähennys) vastaa vähennyslausetta; esim. i.vahenna(a) vastaa lausetta i -= a
  Laadi erillinen pääohjelmaluokka laajennetun Intti-luokan testaamiseen.

  Vaikka luokka Intti saattaa vaikuttaa mielettömältä, sillä voisi olla kuitenkin käyttöä: Piilossa pidetty tavallinen int-muuttuja voitaisiin korvata jollakin tietorakenteella, joka osaa esittää hyvin suuria kokonaislukuja, suurempia kuin valmiilla tyypeillä voi esittää! Luokassa voitaisiin myös varautua kokonaislukuarvon yli- ja alivuotoon.

  Jos kokonaisluvun ylivuotoon haluttaisiin varautua, miten sen voisi tehdä kurssilla jo opitulla kalustolla? Voisiko mitenkään? Myöhemmin tutustutaan yhteen aika käyttökelpoiseen tapaan...

Esimerkkiluokka: PikkuVarasto

Varastoja konstruoidaan seuraavin tavoin:

• public PikkuVarasto() luo varaston, jossa tuotteen nimi on "(nimetön)" ja tuotteen määrä on 0.0
• public PikkuVarasto(double, String) luo varaston, jolle tuotteen määrän alkuarvo annetaan konstruktorin ensimmäisenä parametrina ja tuotteen nimi toisena; jos määrä on negatiivinen, alkuarvoksi asetetaan 0.0

• public double paljonkoOn() palauttaa tuotteen määrän
• public String mikaNimi() palauttaa tuotteen nimen
• public void vieVarastoon(double) lisää varastoon parametrin verran tuotetta; jos parametri on nolla tai negatiivinen, mitään ei muuteta
• public double otaVarastosta(double) poistaa varastosta parametrin verran tuotetta ja palauttaa annettavan määrän arvonaan; jos parametri on negatiivinen, palautetaan 0.0 eikä varaston sisältöä muuteta; jos varastossa ei ole tarpeeksi tuotetta, palautetaan se mitä löytyy ja nollataan määrä

• public String toString() palauttaa arvonaan merkkijonon varastotilanteesta muodossa (esim.):

        (Mehu: 12.32)
      

  Huom: toString()-niminen metodi on erikoisasemassa: Kun luokassa on tällainen määritelty, luokan arvo voidaan tulostaa hyvin vaivattomasti, kts. käyttöesimerkki alla. Melkeinpä luokkaan kuin luokkaan kannattaa ohjelmoida tällainen metodi. Sillä on käyttöä ainakin testauksessa!

• public PikkuVarasto summa(PikkuVarasto) luo PikkuVarasto-olion, jonka tuotteen määrä on alkuperäisen olion ja parametrina annetun varaston määrän summa. Uusi olio saa tuotenimekseen yhdistelmän alkuperäisen ja parametriolion nimistä, so. nimet katenoidaan. (Aika kummallinenhan tämä operaatio on...:-)

public class PikkuVarasto {

  // toteutuksen tietorakenteet:

  private double maara;  // tuotteen määrä  >= 0
  private String tuote;  // tuotteen nimi

  // ----- konstruktorit: -----------

  public PikkuVarasto() {
    this.maara = 0.0;
    this.tuote = "(nimetön)";
  }

  public PikkuVarasto(double maara, String tuote) {
    this.tuote = tuote;  // !! 
    if (maara > 0)
      this.maara = maara;
    else
      this.maara = 0.0;
  }

  // -----  aksessorit: --------

  public double paljonkoOn() {
    return this.maara;
  }

  public String mikaNimi() {
    return this.tuote;
  }

  public void vieVarastoon(double paljonko) { // vain >0 kelpaa
    if (paljonko > 0) 
      this.maara += paljonko;
  }

  public double otaVarastosta(double paljonko) { // vain >0 kelpaa
    if (paljonko <= 0) 
      return 0;
    if (paljonko <= this.maara) {  // vähennetään varastosta
      this.maara -= paljonko;      // koko parametri
      return paljonko;
    } else {                  // annetaan mitä voidaan!
      paljonko = this.maara;
      this.maara = 0;
      return paljonko;
    }
  }


  // ------ muita työkaluja PikkuVarasto-olioiden käsittelyyn: -------


  public String toString() {  // varastotilanne merkkijonona
    return "("+this.tuote+": "+this.maara+")";
  }

  public PikkuVarasto summa(PikkuVarasto toinen) {
    return new PikkuVarasto(this.maara + toinen.paljonkoOn(), 
                            this.tuote + toinen.mikaNimi());
  }

  // ...  

}

public class PikkuVarastoTesti {
  public static void main(String[] args) {

    PikkuVarasto mehua =  new PikkuVarasto(10, "Mehu");
    PikkuVarasto olutta = new PikkuVarasto(123.4, "Olut");
    PikkuVarasto bensaa = new PikkuVarasto(90.1, "Bensa"); 

    // Koska luokkaan on määritelty toString-metodi, 
    // muuttujien arvoja voidaan tulostaa sellaisenaan:

    System.out.println(mehua);
    System.out.println(olutta);
    System.out.println(bensaa);   

/* TULOSTUS:

(Mehu: 10.0)
(Olut: 123.4)
(Bensa: 90.1)
-------------------------------------------------------------- 
*/
    // parametriton konstruktori:

    PikkuVarasto a = new PikkuVarasto();
    System.out.println(a);

/* TULOSTUS:

((nimetön): 0.0)
-------------------------------------------------------------- 
*/
    // viitteen kopiointi:

    PikkuVarasto b = mehua;
    System.out.println("" + b + mehua);

/* TULOSTUS:

(Mehu: 10.0)(Mehu: 10.0)
-------------------------------------------------------------- 
*/
    // kasvatetaan b:tä, myös muuttuja mehua kasvaa:

    b.vieVarastoon(25);
    System.out.println("" + b + mehua);

/* TULOSTUS:

(Mehu: 35.0)(Mehu: 35.0)
-------------------------------------------------------------- 
*/
    // testataan metodeita paljonkoOn() ja mikaNimi()

    System.out.println("Muuttuja bensaa:" + bensaa + ", määrä=" +
                        bensaa.paljonkoOn()+ ", nimi=" +
                        bensaa.mikaNimi());

/* TULOSTUS:

Muuttuja bensaa:(Bensa: 90.1), määrä=90.1, nimi=Bensa
-------------------------------------------------------------- 
*/  
    // varastoon vienti:

    System.out.println(bensaa);
    bensaa.vieVarastoon(27.4);
    System.out.println(bensaa);
    bensaa.vieVarastoon(-34.1);
    System.out.println(bensaa);

/* TULOSTUS:

(Bensa: 90.1)
(Bensa: 117.5)
(Bensa: 117.5)
-------------------------------------------------------------- 
*/
    // varastosta ottaminen:
 
    System.out.println(olutta);
    double saatiin = olutta.otaVarastosta(10.2);
    System.out.println("Saatiin " + saatiin + ", tilanne: "+olutta);
    saatiin = olutta.otaVarastosta(-78.8); 
    System.out.println("Saatiin " + saatiin + ", tilanne: "+olutta);
    saatiin = olutta.otaVarastosta(175.5);
    System.out.println("Saatiin " + saatiin + ", tilanne: "+olutta);

/* TULOSTUS:

(Olut: 123.4)
Saatiin 10.2, tilanne: (Olut: 113.2)
Saatiin 0.0, tilanne: (Olut: 113.2)
Saatiin 113.2, tilanne: (Olut: 0.0)
-------------------------------------------------------------- 
*/
    // summan laskenta:

    olutta.vieVarastoon(432.1);
    PikkuVarasto c = mehua.summa(olutta);
    System.out.println("" + mehua + olutta + c);

    PikkuVarasto d = c.summa(bensaa);
    System.out.println("" + c + bensaa + d);
 
    d = d.summa(bensaa.summa(mehua));
    System.out.println(d);

/* TULOSTUS:

(Mehu: 35.0)(Olut: 432.1)(MehuOlut: 467.1)
(MehuOlut: 467.1)(Bensa: 117.5)(MehuOlutBensa: 584.6)
(MehuOlutBensaBensaMehu: 737.1)
-------------------------------------------------------------- 
*/

  }
}

Olio parametrina ja metodin palauttamana arvona

Olemme käyttäneet valmiita tyyppejä esimerkiksi seuraavaan tapaan:

   String s, t="kissa", u;
   ...
   public int meto1(String a) {
   ...
   }
   public String meto2(int i) {
   ...
   }
   public String meto3(String j) {
   ...
   }

   KuuLaskuri s, t = new KuuLaskuri(), u;
   PikkuVarasto v, w = new PikkuVarasto(32.1, "Öljy");
   ...
   public int meto1(KuuLaskuri a) {
   ...
   }
   public PikkuVarasto meto2(int i) {
   ...
   }
   public KuuLaskuri meto3(PikkuVarasto j) {
   ...
   }

Kun olio (eli viite olioon!) välitetään parametrina, muodollinen parametri saa alkuarvokseen viitteen olioon. Vaikka muodollinen parametri on olemassa vain metodin suorituksen ajan ja siihen tehdyt muutokset eivät vaikuta metodin ulkopuolelle, viitattuun olioon tehdyt muutokset jäävät voimaan metodin suorituksen päätyttyäkin. Metodi voi siis muuttaa parametrina saamansa olion arvoa, jos olion luokka tarjoaa välineitä arvon muuttamiseen.

Laaditaan pieni pääohjelmaluokka, johon ohjelmoidaan metodi KuuLaskuri-olion kasvattamiseen halutulla kuukausimäärällä (ParEsim.java):

public class ParEsim {
  
  private static void superKasvata(KuuLaskuri lask, int paljonko) {
    for (int i=1; i <= paljonko; ++i)
      lask.seuraavaKuu();
  }

  public static void main(String[] args) {
    KuuLaskuri eka = new KuuLaskuri();
    KuuLaskuri toka = new KuuLaskuri();

    System.out.println(eka.moneskoKuu()+" "+toka.moneskoKuu());

    eka.seuraavaKuu();
    superKasvata(toka, 7);

    System.out.println(eka.moneskoKuu()+" "+toka.moneskoKuu());
  }
}

1 1
2 8

Jos sen sijaan muutetaan itse parametrin arvoa (eli viitettä), muutos ei vaikuta todelliseen parametriin (ParEsim2.java):

public class ParEsim2 {
  
  private static void yritaVaihtaa(KuuLaskuri muodPar) {
    muodPar = new KuuLaskuri();
    System.out.println(muodPar.moneskoKuu());
  }

  public static void main(String[] args) {
    KuuLaskuri todPar = new KuuLaskuri();
    todPar.seuraavaKuu();
    todPar.seuraavaKuu();
    System.out.println(todPar.moneskoKuu());
    
    yritaVaihtaa(todPar); // TODELLINEN PAR. EI MUUTU!

    System.out.println(todPar.moneskoKuu());
  }
}

3
1
3

Ohjelmoidaan metodi, joka pyytää käyttäjältä varaston tiedot ja palauttaa kutsujalle PikkuVarasto-olion (OlioArvonaEsim.java):

public class OlioArvonaEsim {

  private static PikkuVarasto lueVarasto() {
    String nimi;
    double sisalto;

    System.out.println("Tuotteen nimi?");
    nimi = Lue.rivi();

    do {
      System.out.println("Tuotteen määrä? (ei-negatiivinen)");
      sisalto = Lue.dluku();
    } while (sisalto < 0);

    return new PikkuVarasto(sisalto, nimi);  // HUOM: viite!
  }

  public static void main(String[] args) {
    PikkuVarasto varasto;

    System.out.println("Luodaanpa varasto!");
    varasto = lueVarasto();

    System.out.println("Varasto on: " + varasto);

    // ... 
  }
}

Täydennetään luokkaa PikkuVarasto metodilla teeKopio(), joka nimensä mukaan tekee kopion Pikkuvarasto2-oliosta (PikkuVarasto2.java).

public class PikkuVarasto2 {

  private double maara;  // tuotteen määrä  >= 0
  private String tuote;  // tuotteen nimi

  public PikkuVarasto2() { ...
  public PikkuVarasto2(double maara, String tuote) { ...
  public double paljonkoOn() { ...
  public String mikaNimi() { ...
  public void vieVarastoon(double paljonko) { // vain >0 kelpaa
  public double otaVarastosta(double paljonko) { ...
  public String toString() { ...
  public PikkuVarasto2 summa(PikkuVarasto2 toinen) { ...

  public PikkuVarasto2 teeKopio() {
    double maara = this.maara;
    String tuote = this.tuote;
    PikkuVarasto2 uusi = new PikkuVarasto2(maara, tuote);
    return uusi;

    // tai lyhyemmin: 
    //   return new PikkuVarasto2(this.maara, this.tuote),

  }
  // ...  
}

public class PikkuVarasto2Testi {
  public static void main(String[] args) {

    PikkuVarasto2 mehua =  new PikkuVarasto2(10, "Mehu");
    PikkuVarasto2 a, b;

    a = mehua;
    b = mehua.teeKopio();

    System.out.println("mehua: "+mehua+", a: "+a+", b: "+b );

    mehua.vieVarastoon(2);
    a.vieVarastoon(3);
    b.vieVarastoon(4);

    System.out.println("mehua: "+mehua+", a: "+a+", b: "+b );
  }
}

Mehua: (Mehu: 10.0), a: (Mehu: 10.0), b: (Mehu: 10.0)
Mehua: (Mehu: 15.0), a: (Mehu: 15.0), b: (Mehu: 14.0)

Takaisin luvun 2 sisällysluetteloon.