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

Java toString method

toString method inwards Java is used to supply clear in addition to concise information well-nigh Object inwards human readable format. Influenza A virus subtype H5N1 correctly overridden toString method tin assistance inwards logging in addition to debugging of Java program past times providing valuable in addition to meaningful information. Since toString() is defined inwards java.lang.Object degree in addition to its default implementation don't supply much information, it's e'er a best practise to override the toString method inwards sub class. In fact, if yous are creating value degree or domain degree e.g. Order, Trade or Employee,  always override equals,hashCode, compareTo in addition to toString method inwards Java.  By default toString implementation produces output inwards 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 inwards hex format, if yous telephone vociferation upwards hashCode method it volition render 26094370, which is decimal equivalent of 18e2b22. This information is non real useful piece troubleshooting whatever problem. 

Let’s run into a existent life instance where yous are troubleshooting network connectivity issues, inwards instance of this yous desire to know which host in addition to port your organization is trying to connect in addition to if Socket or ServerSocket degree 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 run into to a greater extent than or less tips to override toString method alongside code examples.

How to override toString method inwards Java:

overriding whatever method inwards Java, yous bespeak to follow rules of method overriding. Any means at that topographic point are many means to implement or override toString() method e.g.  You tin write this method manually, yous tin utilization IDE similar Netbeans in addition to Eclipse to generate toString method or yous tin utilization Apache park ToStringBuilder to generate toString method inwards multiple styles similar unmarried line, multi-line etc. Here are few points to scream back piece overriding toString() method inwards Java, which volition assistance yous to acquire most from your toString() implementation.

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

This is real helpful tip piece overriding Java’s toString() method. Since toString() of java.util.Date degree does non impress formatted engagement in addition to includes lots of details which is non e'er necessary. If yous are using a particular DateFormat e.g. dd-MM-yy inwards your application, they yous definitely desire to run into dates on that format instead of default. IDE unremarkably does non generate formatted Date output in addition to this is something yous bespeak to do past times yourself  but its worth of effort. See How to impress Date inwards ddMMyy format inwards Java for to a greater extent than details on formatting Date inwards Java. You tin either utilization SimpleDateFormat degree or Joda Date fourth dimension library for this purpose.

Document toString format

If your toString() method is non printing information inwards price of field=value, Its expert sentiment to document format of toString, peculiarly for value objects similar Employee or Student. For instance if toString() method of Employee prints "John-101-Sales-9846387321" than its expert sentiment 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 yous should e'er supply 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 e'er a cleaner means to asking information.

Use StringBuilder to generate toString output

If yous writing code for toString() method inwards Java, in addition to hence utilization StringBuilder to append private attribute.  If yous are using IDE similar Eclipse, Netbeans or IntelliJ in addition to hence likewise using  StringBuilder in addition to append() method instead of + operator to generate toString method is expert way. By default both Eclipse in addition to Netbeans generate toString method alongside concatenation operator .

Use @Override annotation

Using @Override notation piece overriding method inwards Java is i of the best practise inwards Java. But this tip is non equally of import equally it was inwards instance 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 inwards Java but it doesn’t override toString method in addition to when yous impress array, it volition utilization default format which is non real helpful because nosotros want  to run into contents of Array. By the means this is to a greater extent than or less other argue why char[] array are preferred over String for storing sensitive information e.g. password. Take a minute to run into 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 inwards Java

1. Print output of toString inwards multiple occupation or unmarried occupation based upon it length.

2. Include amount qualified advert of degree inwards toString representation e.g. package.class to avoid whatever confusion/

3. You tin either skip goose egg values or present them, its improve to acquire out them. Sometime they are useful equally they dot which fields are goose egg at the fourth dimension of whatever incident e.g. NullPointerException.

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

5. Include inherited members if yous affair they supply must accept information inwards nipper class.

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

 toString Example inwards Java 

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

/**
 * Java program to demonstrate How to override toString() method inwards Java.
 * This Java plan shows How tin yous utilization IDE similar Netbeans or Eclipse
 * in addition to Open root library similar Apache park ToStringBuilder to

 * override toString inwards 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 Bharat = new Country("India");
            India.setCapital("New Delhi");
            India.setIndependenceDay("15/07/1947");
            India.setPopulation(1200000000);
           
            System.out.println(India);      
   }

}

toString method created past times Netbeans IDE
toString method generated past times Netbeans IDE create next output for higher upwards degree :

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

If yous await at higher upwards output yous detect that NetBeans does non generated formatted Date for you, instead it calls toString() method of java.util.Date class.

toString() code generated past times Eclipse IDE:

By default Eclipse generates next toString method :

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

You tin generate code for toString method inwards Eclipse past times clicking Source --Generate toString(). It likewise supply several options similar choosing code fashion e.g. concatenation operator or StringBuffer etc. Here is the output of toString() method nosotros only created past times 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 park provides to a greater extent than or less other precious rock called ToStringBuilder which tin generate code for toString() method inwards dissimilar styles. Let’s how does output of toString method looks similar inwards uncomplicated fashion 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 root library Guava likewise supply convenient API to generate code for toString method inwards Java.

When toString method is invoked inwards Java

toString is a rather special method in addition to invoked past times many Java API methods similar println(), printf(), loggers, assert statement, debuggers inwards IDE, piece printing collections in addition to alongside concatenation operator. If subclass doesn't override toString() method than default implementation defined inwards Object degree gets invoked. Many programmers either utilization logging API similar Log4J or java.util.Logger to impress logs in addition to frequently locomote past times Object there.  logger.info("Customer non establish : " + customer) in addition to if Customer doesn't override toString in addition to impress meaningful information similar customerId, customerName etc than it would hold out hard to diagnose the problem. This why its e'er expert to override toString inwards Java.let's run into to a greater extent than or less benefits of doing this.

Benefits of overriding toString method:

1) As discussed above, correctly overridden toString helps inwards debugging past times printing meaningful information.

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

3) If yous are debugging Java plan inwards Eclipse than using lookout adult man or inspect characteristic to await object, toString volition definitely assistance you.

These are only to a greater extent than or less of the benefits yous acquire past times implementing or overriding toString method inwards Java, at that topographic point are many to a greater extent than which yous acquire in addition to acquire past times yourself. I promise these tips volition assistance yous to acquire most of your toString implementation. Let us know  if yous whatever unique toString() tips which has helped yous inwards your Java application.

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

Why String is immutable inwards Java

Why String is a pop HashMap fundamental inwards Java

How SubString plant inwards Java

How to dissever String inwards Java

How to supervene upon String using regular human face inwards Java