Pyyhkäise näyttääksesi valikon

Kuinka tulostaa olio helposti

Jos haluat näyttää kaikki olion tiedot käyttämällä komentoa System.out.println(object); Javassa, käytössä on metodi nimeltä toString();.

toString()

toString-metodi Javassa on sisäänrakennettu metodi, joka kuuluu Object-luokkaan. Sitä käytetään palauttamaan olion merkkijonoesityksen. Oletuksena, kun kutsumme toString-metodia oliolle, se palauttaa merkkijonon, joka sisältää luokan nimen ja olion hashkoodin. Tarkastellaan esimerkkiä:

Main.java


              1234567891011121314151617181920
            
package com.example;

class Person {
    String name;
    int age;
    String gender;

    public Person(String name, int age, String gender) {
        this.name = name;
        this.age = age;
        this.gender = gender;
    }
}

public class Main {
    public static void main(String[] args) {
        Person bob = new Person("Bob", 20, "male");
        System.out.println(bob);
    }
}

HashCode

Hashkoodi on yksinkertaisesti sanottuna yksilöllinen tunniste oliolle, joka on tallennettu muistiin. Voimme myös tarkastella olion hashkoodia kutsumalla sille hashCode()-metodia, esimerkiksi:

Main.java


              123456789101112131415161718192021
            
package com.example;

class Person {
    String name;
    int age;
    String gender;

    public Person(String name, int age, String gender) {
        this.name = name;
        this.age = age;
        this.gender = gender;
    }
}

public class Main {
    public static void main(String[] args) {
        Person bob = new Person("Bob", 20, "male");
        int code = bob.hashCode();
        System.out.println(code);
    }
}

Tässä tapauksessa herää kysymys: kuinka voimme saada jotain tarkempaa kuin olion hash-koodin? Tällaisissa tilanteissa voimme ylikirjoittaa toString()-metodin.

Perintä ja metodin ylikirjoitus ovat laajoja aiheita, joita käsitellään erillisessä kurssissa. Tässä vaiheessa käytämme metodin ylikirjoitusta vain toString()-metodille.

toString()-metodin käyttö

Metodin ylikirjoittamiseksi tulee käyttää seuraavaa syntaksia:

Main.java


              1234
            
@Override
public String toString() {
  // block of code
}

Käytämme annotaatiota @Override ennen tätä metodia. Tämän annotaation avulla kääntäjä tunnistaa, että olemme ylikirjoittamassa kyseistä metodia. Seuraavaksi määrittelemme syntaksin public String toString(), joka osoittaa, minkä metodin tarkalleen olemme ylikirjoittamassa.

Tämän metodin rungossa määrittelemme, miten olio esitetään merkkijonona. Ylikirjoitetaan metodi Person-luokalle:

Person.java


              12345678910111213141516171819
            
class Person {
    String name;
    int age;
    String gender;

    public Person(String name, int age, String gender) {
        this.name = name;
        this.age = age;
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "Class Person;" + System.lineSeparator()
                + "name = " + name + ";" + System.lineSeparator()
                + "age = " + age + ";" + System.lineSeparator()
                + "gender = " + gender + ".";
    }
}

Komento System.lineSeparator() luo uuden rivin. Olemme määritelleet, miltä olion tulisi näyttää yhdistämällä merkkijonoja niiden arvoihin. Siksi, kun yritämme tulostaa Person-luokan olion, näemme yksityiskohtaiset tiedot jokaisesta kentästä. Tulostetaan olio main-metodin avulla ja katsotaan, miltä se näyttää:

Main.java


              12345678910111213141516171819202122232425262728
            
package com.example;

public class Main {
    public static void main(String[] args) {
        Person bob = new Person("Bob", 20, "male");
        System.out.println(bob);
    }
}

class Person {
    String name;
    int age;
    String gender;

    public Person(String name, int age, String gender) {
        this.name = name;
        this.age = age;
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "Class Person;" + System.lineSeparator()
                + "name = " + name + ";" + System.lineSeparator()
                + "age = " + age + ";" + System.lineSeparator()
                + "gender = " + gender + ".";
    }
}

Olemme saaneet tietoa luokasta, johon olio bob kuuluu, sekä kaikista sen kentistä. Näin ollen voimme ylikirjoittaa ja määritellä toString()-metodin näyttämään halutut tiedot olion tulostuksen yhteydessä. Luodaan toinen olio tästä luokasta konstruktorin avulla, jotta nähdään ja vahvistetaan, miten toString()-metodi muuntaa olion:

Main.java


              123456789101112131415161718192021222324252627282930
            
package com.example;

public class Main {
    public static void main(String[] args) {
        Person bob = new Person("Bob", 20, "male");
        System.out.println(bob);
        Person alice = new Person("Alice", 17, "female");
        System.out.println(alice);
    }
}

class Person {
    String name;
    int age;
    String gender;

    public Person(String name, int age, String gender) {
        this.name = name;
        this.age = age;
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "Class Person;" + System.lineSeparator()
                + "name = " + name + ";" + System.lineSeparator()
                + "age = " + age + ";" + System.lineSeparator()
                + "gender = " + gender + "." + System.lineSeparator();
    }
}

Voimme nähdä, että uusi olio alice näytetään konsolissa samalla mallilla.

Yhteenveto

Käyttämällä toString()-metodia olemme huomattavasti yksinkertaistaneet olion tietojen näyttämistä ruudulla, mikä mahdollistaa tilan säästämisen päämetodissa.