10 Tips To Override Tostring() Method Inwards Coffee - Tostringbuilder Netbeans Eclipse

Java toString method

toString method inward Java is used to render clear in addition to concise information almost Object inward human readable format. Influenza A virus subtype H5N1 correctly overridden toString method tin assist inward logging in addition to debugging of Java program yesteryear providing valuable in addition to meaningful information. Since toString() is defined inward java.lang.Object cast in addition to its default implementation don't render much information, it's ever a best do to override the toString method inward sub class. In fact, if you lot are creating value cast or domain cast e.g. Order, Trade or Employee,  always override equals,hashCode, compareTo in addition to toString method inward Java.  By default toString implementation produces output inward the cast package.class@hashCode e.g. for our toString() example, Country class’ toString() method volition impress test.Country@18e2b22 where 18e2b22 is hashCode of an object inward hex format, if you lot telephone band hashCode method it volition render 26094370, which is decimal equivalent of 18e2b22. This information is non really useful piece troubleshooting whatsoever problem. 

Let’s encounter a existent life illustration where you lot are troubleshooting network connectivity issues, inward illustration of this you lot desire to know which host in addition to port your organization is trying to connect in addition to if Socket or ServerSocket cast exclusively impress default toString information than its impossible to figure out the actual problem, but alongside a decent toString implementation they tin impress useful information similar hostname in addition to port. 

In this Java  tutorial nosotros volition encounter roughly tips to override toString method alongside code examples.

How to override toString method inward Java:

overriding whatsoever method inward Java, you lot ask to follow rules of method overriding. Any agency at that topographic point are many agency to implement or override toString() method e.g.  You tin write this method manually, you lot tin utilisation IDE similar Netbeans in addition to Eclipse to generate toString method or you lot tin utilisation Apache common ToStringBuilder to generate toString method inward multiple styles similar unmarried line, multi-line etc. Here are few points to recall piece overriding toString() method inward Java, which volition assist you lot to acquire most from your toString() implementation.

Print formatted appointment e.g. dd-MM-yy instead of raw date

This is really helpful tip piece overriding Java’s toString() method. Since toString() of java.util.Date cast does non impress formatted appointment in addition to includes lots of details which is non ever necessary. If you lot are using a particular DateFormat e.g. dd-MM-yy inward your application, they you lot definitely desire to encounter dates on that format instead of default. IDE unremarkably does non generate formatted Date output in addition to this is something you lot ask to do yesteryear yourself  but its worth of effort. See How to impress Date inward ddMMyy format inward Java for to a greater extent than details on formatting Date inward Java. You tin either utilisation SimpleDateFormat cast or Joda Date fourth dimension library for this purpose.

Document toString format

If your toString() method is non printing information inward damage of field=value, Its skilful regard to document format of toString, specially for value objects similar Employee or Student. For illustration if toString() method of Employee prints "John-101-Sales-9846387321" than its skilful regard to specify format equally "name-id-department-contact", but at the same fourth dimension don't allow your client extract information from toString() method in addition to you lot should ever render corresponding getter methods similar getName(), getId(), getContact() etc, because extracting information from toString() representation of Object is delicate in addition to mistake prone in addition to client should ever a cleaner agency to asking information.

Use StringBuilder to generate toString output

If you lot writing code for toString() method inward Java, thence utilisation StringBuilder to append private attribute.  If you lot are using IDE similar Eclipse, Netbeans or IntelliJ thence besides using  StringBuilder in addition to append() method instead of + operator to generate toString method is skilful way. By default both Eclipse in addition to Netbeans generate toString method alongside concatenation operator .

Use @Override annotation

Using @Override musical note piece overriding method inward Java is i of the best do inward Java. But this tip is non equally of import equally it was inward illustration of overriding equals() in addition to compareTo() method, equally overloading instead of overriding tin do to a greater extent than subtle bugs there. Anyway it’s best to using @Override annotation.

Print contents of Array instead of printing array object

Array is an object inward Java but it doesn’t override toString method in addition to when you lot impress array, it volition utilisation default format which is non really helpful because nosotros want  to encounter contents of Array. By the agency this is roughly other argue why char[] array are preferred over String for storing sensitive information e.g. password. Take a minute to encounter if printing content of array helps your user or non in addition to if it brand feel than impress contents instead of array object itself. Apart from functioning argue prefer Collection similar ArrayList or HashSet over Array for storing other objects.

Bonus Tips

Here are few to a greater extent than bonus tips on overriding toString method inward Java

1. Print output of toString inward multiple business or unmarried business based upon it length.

2. Include amount qualified mention of cast inward toString representation e.g. package.class to avoid whatsoever confusion/

3. You tin either skip aught values or present them, its ameliorate to move out them. Sometime they are useful equally they betoken which fields are aught at the fourth dimension of whatsoever incident e.g. NullPointerException.

4. Use fundamental value format similar member.name=member.value equally most of IDE besides follows that.

5. Include inherited members if you lot matter they render must convey information inward fry class.

6. Sometime an object contains many optional in addition to mandatory parameters similar nosotros shown inward our Builder designing example, when its non practically possible to impress all fields inward those cases printing a meaningful information, non necessary fields is better.

 toString Example inward Java 

We volition utilisation next cast to demonstrate our toString examples for Netbeans, Eclipse in addition to Apache's ToStringBuilder utility.

/**
 * Java program to demonstrate How to override toString() method inward Java.
 * This Java programme shows How tin you lot utilisation IDE similar Netbeans or Eclipse
 * in addition to Open origin library similar Apache common ToStringBuilder to

 * override toString inward Java.
 *
 * @author .blogspot.com
 */

public class Country{
    private String name;
    private String capital;
    private long population;
    private Date independenceDay;

    public Country(String name){
        this.name = name;
    }
 
    public String getName(){ return name; }
    public void setName(String name) {this.name = name;}
 
    public String getCapital() {return capital;}
    public void setCapital(String capital) {this.capital = capital;}

    public Date getIndependenceDay() {return independenceDay;}
    public void setIndependenceDay(Date independenceDay) {this.independenceDay = independenceDay;}

    public long getPopulation() { return population; }
    public void setPopulation(long population) {this.population = population; }

    @Override
    public String toString() {
        return "Country{" + "capital=" + uppercase + ",
               population=" + population + ",
               independenceDay=" + independenceDay + '}';

    }

    public void setIndependenceDay(String date) {
        DateFormat format = new SimpleDateFormat("dd/MM/yyyy");
        try {
            this.independenceDay = format.parse(date);
        } catch (ParseException ex) {
            Logger.getLogger(Country.class.getName()).log(Level.SEVERE, null, ex);
        }
    }
   

   public static void main(String args[]){
            Country Republic of Republic of India = new Country("India");
            India.setCapital("New Delhi");
            India.setIndependenceDay("15/07/1947");
            India.setPopulation(1200000000);
           
            System.out.println(India);      
   }

}

toString method created yesteryear Netbeans IDE
toString method generated yesteryear Netbeans IDE attain next output for inward a higher house cast :

Country{capital=New Delhi, population=1200000000, independenceDay=Fri Aug fifteen 00:00:00 VET 1947}

If you lot expect at inward a higher house output you lot abide by that NetBeans does non generated formatted Date for you, instead it calls toString() method of java.util.Date class.

toString() code generated yesteryear Eclipse IDE:

By default Eclipse generates next toString method :

@Override
    public String toString() {
        return "Country [name=" + mention + ", capital=" + capital
                + ", population=" + population + ", independenceDay="
                + independenceDay + "]";
    }

You tin generate code for toString method inward Eclipse yesteryear clicking Source --Generate toString(). It besides render several options similar choosing code agency e.g. concatenation operator or StringBuffer etc. Here is the output of toString() method nosotros merely created yesteryear Eclipse :

Country [name=India, capital=New Delhi, population=1200000000, independenceDay=Tue Jul 15 00:00:00 VET 1947]

Using ToStringBuilder for overriding Java toString method

Along alongside many useful classes similar PropertyUtils, EqualsBuilder or HashCodeBuilder; Apache common provides roughly other jewel called ToStringBuilder which tin generate code for toString() method inward unlike styles. Let’s how does output of toString method looks similar inward uncomplicated agency in addition to multi-line style.

Simple Style:
India,New Delhi,1200000000,Fri Aug 15 00:00:00 VET 1947

Multi-line style:
test.Country@f0eed6[
  name=India
  capital=New Delhi
  population=1200000000
  independenceDay=Fri Aug 15 00:00:00 VET 1947
]

NO_FIELD_NAMES_STYLE
test.Country@1d05c81[India,New Delhi,1200000000,Fri Aug 15 00:00:00 VET 1947]

SHORT_PREFIX_STYLE
Country[name=India,capital=New Delhi,population=1200000000,independenceDay=Fri Aug 15 00:00:00 VET 1947]

ToStringStyle.DEFAULT_STYLE
test.Country@1d05c81[name=India,capital=New Delhi,population=1200000000,independenceDay=Fri Aug 15 00:00:00 VET 1947]

Similarly Google’s opened upwards origin library Guava besides render convenient API to generate code for toString method inward Java.

When toString method is invoked inward Java

toString is a rather special method in addition to invoked yesteryear many Java API methods similar println(), printf(), loggers, assert statement, debuggers inward IDE, piece printing collections in addition to alongside concatenation operator. If subclass doesn't override toString() method than default implementation defined inward Object cast gets invoked. Many programmers either utilisation logging API similar Log4J or java.util.Logger to impress logs in addition to oft overstep Object there.  logger.info("Customer non flora : " + customer) in addition to if Customer doesn't override toString in addition to impress meaningful information similar customerId, customerName etc than it would move hard to diagnose the problem. This why its ever skilful to override toString inward Java.let's encounter roughly benefits of doing this.

Benefits of overriding toString method:

1) As discussed above, correctly overridden toString helps inward debugging yesteryear printing meaningful information.

2) If value objects are stored inward Collection than printing collection volition invoke toString on stored object which tin impress really useful information.One of the classic illustration of non overriding toString method is Array inward Java, which prints default implementation rather than contents of array. Though at that topographic point are brace of ways to impress contents of array using Arrays.toString() etc but given Array is an object inward Java, would convey been much ameliorate if Array know how to impress itself much similar Collection classes similar List or Set.

3) If you lot are debugging Java programme inward Eclipse than using lookout adult man or inspect characteristic to expect object, toString volition definitely assist you.

These are merely roughly of the benefits you lot acquire yesteryear implementing or overriding toString method inward Java, at that topographic point are many to a greater extent than which you lot acquire in addition to acquire yesteryear yourself. I promise these tips volition assist you lot to acquire most of your toString implementation. Let us know  if you lot whatsoever unique toString() tips which has helped you lot inward your Java application.

Further Learning
Complete Java Masterclass
4 ways to compare String inward Java

Why String is immutable inward Java

Why String is a pop HashMap fundamental inward Java

How SubString industrial plant inward Java

How to divide String inward Java

How to supersede String using regular appear inward Java