Welcome!

Java Authors: Carmen Gonzalez, Jim Kaskade, Aater Suleman, Pat Romanski, Paige Leidig

Related Topics: Java

Java: Article

Java Gotchas: Instance Variables Hiding

Java Gotchas: Instance Variables Hiding

If methods with the same signatures or member variables with the same name exist in ancestor and descendant classes, the Java keyword super allows access members of the ancestor. But what if you do not use the keyword super in the descendant class? In case of methods, this is called method overriding and only the code of the descendant's method will execute. But when both classes have a member variable with the same name, it may cause a confusion and create hard to find bugs.

Recently in one of the Java online forums, a user with id cityart posted a question about a "strange behavior" of his program, and I decided to do some research on this subject.

Let's take a look at the Java program that declares a variable greeting in both super and subclasses (class A and class B). The subclass B also overrides the Object's method toString(). Please note, that the variable obj has a type of the superclass (A), but it points at the instance of the subclass (B), which is perfectly legal.


class A {
   public String greeting ="Hello";
}

class B extends A {
	public String greeting="Good Bye";
	 public String toString(){
		return greeting;
	}
}

public class VariableOverridingTest {
    public static void main(String[] args) {
      A obj = new B();
      obj.greeting="How are you";

      System.out.println(obj.greeting);
      System.out.println(obj.toString());
 }
}

If you compile and run this program, it'll print the following:

How are you
Good Bye

How come? Aren't we printing a member variable greeting of the same instance of the class B? The answer is no. If you run this program in IDE through a debugger, you'll see that there are two separate variables greeting. For example, Eclipse IDE shows these variables as greeting(A) and greeting(B). The first print statement deals with the member variable of the class A since obj has a type A, and the second print uses a method of the instance B that uses its own variable greeting.

Now, change the declaration of the variable obj to


      B obj = new B();

Run the program, and it'll print "How are you" twice.

But since you wanted the variable obj to have the type of the superclass A, you need to find a different solution. In the code below, we prohibit direct access to the variable greeting by making it private and introducing public setter and getter methods in both super and subclasses. Please note that in the following example, we override the setter and getter in the class B. This gives us a better control of which variable greeting to use.


class A {
 private String greeting ="Hello";
 public void setGreeting(String greet){greeting = greet;}
 public String getGreeting(){return greeting;}

}

class B extends A {
	 private String greeting="Good Bye";
	 public String toString(){
		return greeting;
	}
public void setGreeting(String greet){greeting = greet;}
public String getGreeting(){return greeting;}

}

public class VariableOverridingTest2 {
public static void main(String[] args) {
A obj = new B();

obj.setGreeting("How are you");

System.out.println(obj.getGreeting());
System.out.println(obj.toString());

}
}

This example is yet another illustration of how encapsulation may help you to avoid potential errors caused by multiple declarations of member variables with the same name in the inheritance hierarchy. If needed, we still can access the superclass' variable greeting from the class B by using super.getGreeting().

In Sun's Java tutorial, I found only a brief mentioning of member variables inheritance over here: http://java.sun.com/docs/books/tutorial/java/javaOO/subclass.html

Basically, you can hide a variable but override a method of a superclass. Java Language Specification describes hiding of instance variables over here: http://java.sun.com/docs/books/jls/ second_edition/html/classes.doc.html#229119

One more term to be aware of is shadowing. Here's another Sun's article that discusses hiding and shadowing: http://java.sun.com/developer/TechTips/2000/tt1010.html#tip2 What do you think of the following quote from this article: "First an important point needs to be made: just because the Java programming language allows you to do something, it doesn't always mean that it's a desirable thing to do." Well, if a feature is not desirable, why keep it in the language? Most likely, creators of the language decided to keep a separate copy of the superclass' instance variable to give developers a freedom to define their own subclasses without worrying of overriding by accident some internal members of the superclasses. But in my opinion it should be a responsibility of the superclasses to protect their members.

I'd love to see some practical examples, which would show when this feature of the Java language could be useful.

More Stories By Yakov Fain

Yakov Fain is a co-founder of two software companies: Farata Systems and SuranceBay. He authored several technical books and lots of articles on software development. Yakov is Java Champion (https://java-champions.java.net). He leads leads Princeton Java Users Group. Two of Yakov's books will go in print this year: "Enterprise Web Development" (O'Reilly) and "Java For Kids" (No Starch Press).

Comments (11) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
Chakra Yadavalli 09/15/04 08:53:53 AM EDT

I guess the author clearly states what the problem is and how the encapsulation helps in avoiding the potential errors. I think the following line from the text of the article would be enough to red flag this for any rational developer. Or, this may make it more noticeable :-)

LOOK AT THE LINE BELOW. POTENTIAL BUG!!!

"This example is yet another illustration of how encapsulation may help you to avoid potential errors caused by multiple declarations of member variables with the same name in the inheritance hierarchy. If needed, we still can access the superclass' variable greeting from the class B by using super.getGreeting()."

And in most scenarios of real software development, we never have the luxury of time to track the "patient zero" who coded this sort of bug and treat him. :-)

As for the existence of debates such as this, THEY SHOULD (I mean MUST) exist for the sake of posterity. The correct solutions to these problems to be aware of such problems. If one thinks that articles such as this are "encouraging" the such "malpractices" (without reading the complete articles) then they are wrong and should be advised to use good commonsense in adopting coding techniques.

F. Libuste 09/15/04 07:53:37 AM EDT

The problem of hiding variables will never arise if you apply good practices of Oriented Object programming and NEVER make use of anything else than "private" as a modifier for class members. And yse accessors when needed.

Now as for method overriding, well...that is *exactly* what OO design is for. Making sure your objects are correctly polymorphic, behave properly and offer the proper services and proper extensibility through their exposed methods.

This whole debate should not exist in the first place, and to me, the article comes from software malpractice, and is not depicted as such, which is not so good IMHO. Correct OO design is the issue that should be addressed here, not the effects of it.

Chakra Yadavalli 09/14/04 11:07:46 AM EDT

Good pitfall. This is quite common and very had to find if you have more than two classes in the inheritance tree and the instance members are "protected" which is very common thing that we see. If we go by Bertrand Myer's Object Oriented software construction, which enforces strict encapsulation by saying no to protected variables, we will *not* run in to these sort of problems. But then again, we may be tempted to write "Train Wreck" code -- obj.getThis().getThat().getSomething()

There is another pitfall that has the disguise of this "overridding." Guess what is printed by the following code?

public class A {
public static void getInstance(){
System.out.println("class A");
}
}

public class B extends A {
public static void getInstance(){
System.out.println("class B");
}
}

public class Tester {
public staic void main(Strnig[] args) {
A obj = new B();
obj.getInstance();
}
}

This would print "class A" because, the static methods go by the name "class methods" in Java. In C++, similar code would print "class B". Java language says, static/class methods are not inherited and cannot be overriden. But allowing to define classes with the same name, though legal when looked from the namespace perspective, would result in these pitfalls. The irony with these "false" static methods AKA class methods is that, it makes your brain hurt when you look at code like the one below... Keeps you guessing why it does not throw NullPointerException.

A obj = null;
obj.getInstance();

These are the many good reasons why one should enforce, with the help of IDEs like Eclipse, the practice of qualifying instance members with "this", "super" and static members with the "type name".

Sebastian Tyrrell 09/14/04 10:39:38 AM EDT

Both David Hibbs and J.R. Titko are right that there is no problem if the design is right - in particular if you have proper encapsulation (i.e. keep the data member private and use getter and setter functions). But I still can't imagine a single legitimate usage. The closest I can come is that it means that you don't need to worry what (private) data members base classes might have, and can reuse their names for your own purposes. I think this is what David means when he says "... the capability to do this is required or else behaviours of parent classes are not encapsulated ...". I'm not convinced - a compile error at this point might save a lot of grief later.

David Hibbs 09/14/04 09:30:26 AM EDT

Mr. Tyrrell commented that "...it is the type of the object, not the type of the pointer, that determines the behaviour. To me, that makes it a fault rather than a feature!"

In some regards, yes. The key word here though is "behaviour". Behaviour as in, what happens when a method is invoked? Direct access of fields (IMHO) is not a "behaviour" of an object.

Allowing access to member fields like this is poor style and design in any OO language.

Proper encapsulation helps this problem. This is not to say that encapsulation is a cure-all; indeed, generating getters and setters for the field in the child class (in effect, overriding them and shadowing them at the same time!) can create a whole new set of hard-to-find bugs.

The bottom line: proper design, planning, and review will avoid the pitfall, while the capability to do this is required or else behaviors of parent classes are not encapsulated -- and subject to breakage by children.

J.R. Titko 09/14/04 09:27:52 AM EDT

I have been using this example when teaching for a couple years to show what to avoid in coding Java. It is a situation set up at compile time by the compiler making the substitution of the literal for the variable. I agree its a problem in the language, but can easily be avoided by always using getters and setters to revtrieve instance level variables.

Sebastián Tyrrell 09/14/04 08:10:42 AM EDT

It seems to me from the examples that there is no way of utilising this feature without breaking the Liskov substitution principle that it is the type of the object, not the type of the pointer, that determines the behaviour. To me, that makes it a fault rather than a feature!

Sudipto Nandan 09/14/04 06:41:38 AM EDT

The article is good but can be very briefly eneded by saying that
When a method is called by a reference object, it takes into consideration the Object it is referencing and not the type of referencing object.
While, when a memeber variable is accessed by a reference object, the type of the referencing object is taken into consideration and not the object it is referencing.

MarkusH 09/14/04 05:13:39 AM EDT

This is another example how important it is, that every Developer has easy to use access to Software Audits in it's IDE, so that suspicious constructs like this don't survive until the check-in... i.e. the Audits provided by Borland Together in JBuilder and Eclipse-based IDE's

Narayanan R 09/14/04 12:43:11 AM EDT

It was interesting. It is the behavior of an object that is defined by its type (whose instance it is). I think the attributes of an object are defined by the handle used, since in Java methods are only bound at runtime.
Simple typecasting with the superclass/subclass can have obtained the desired result, as long as the typecast is valid.

Just Nell 09/13/04 09:53:13 PM EDT

Perhaps a better way to demonstrate is to print obj.greeting before setting, e.g.,

A obj = new B();
System.out.println(obj.greeting);
obj.greeting="How are you";

System.out.println(obj.greeting);
System.out.println(obj.toString());

@ThingsExpo Stories
SYS-CON Events announces a new pavilion on the Cloud Expo floor where WebRTC converges with the Internet of Things. Pavilion will showcase WebRTC and the Internet of Things. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devices--computers, smartphones, tablets, and sensors – connected to the Internet by 2020. This number will continue to grow at a rapid pace for the next several decades.
The only place to be June 9-11 is Cloud Expo & @ThingsExpo 2015 East at the Javits Center in New York City. Join us there as delegates from all over the world come to listen to and engage with speakers & sponsors from the leading Cloud Computing, IoT & Big Data companies. Cloud Expo & @ThingsExpo are the leading events covering the booming market of Cloud Computing, IoT & Big Data for the enterprise. Speakers from all over the world will be hand-picked for their ability to explore the economic strategies that utility/cloud computing provides. Whether public, private, or in a hybrid form, clo...
SYS-CON Events announced today that Gridstore™, the leader in software-defined storage (SDS) purpose-built for Windows Servers and Hyper-V, will exhibit at SYS-CON's 15th International Cloud Expo®, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Gridstore™ is the leader in software-defined storage purpose built for virtualization that is designed to accelerate applications in virtualized environments. Using its patented Server-Side Virtual Controller™ Technology (SVCT) to eliminate the I/O blender effect and accelerate applications Gridsto...
SYS-CON Events announced today that Red Hat, the world's leading provider of open source solutions, will exhibit at Internet of @ThingsExpo, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Red Hat is the world's leading provider of open source software solutions, using a community-powered approach to reliable and high-performing cloud, Linux, middleware, storage and virtualization technologies. Red Hat also offers award-winning support, training, and consulting services. As the connective hub in a global network of enterprises, partners, a...
As the Internet of Things unfolds, mobile and wearable devices are blurring the line between physical and digital, integrating ever more closely with our interests, our routines, our daily lives. Contextual computing and smart, sensor-equipped spaces bring the potential to walk through a world that recognizes us and responds accordingly. We become continuous transmitters and receivers of data. In his session at Internet of @ThingsExpo, Andrew Bolwell, Director of Innovation for HP’s Printing and Personal Systems Group, will discuss how key attributes of mobile technology – touch input, senso...
The Internet of Things (IoT) is making everything it touches smarter – smart devices, smart cars and smart cities. And lucky us, we’re just beginning to reap the benefits as we work toward a networked society. However, this technology-driven innovation is impacting more than just individuals. The IoT has an environmental impact as well, which brings us to the theme of this month’s #IoTuesday Twitter chat. The ability to remove inefficiencies through connected objects is driving change throughout every sector, including waste management. BigBelly Solar, located just outside of Boston, is trans...
Connected devices and the Internet of Things are getting significant momentum in 2014. In his session at Internet of @ThingsExpo, Jim Hunter, Chief Scientist & Technology Evangelist at Greenwave Systems, will examine three key elements that together will drive mass adoption of the IoT before the end of 2015. The first element is the recent advent of robust open source protocols (like AllJoyn and WebRTC) that facilitate M2M communication. The second is broad availability of flexible, cost-effective storage designed to handle the massive surge in back-end data in a world where timely analytics...
Internet of @ThingsExpo Silicon Valley announced on Thursday its first 12 all-star speakers and sessions for its upcoming event, which will take place November 4-6, 2014, at the Santa Clara Convention Center in California. @ThingsExpo, the first and largest IoT event in the world, debuted at the Javits Center in New York City in June 10-12, 2014 with over 6,000 delegates attending the conference. Among the first 12 announced world class speakers, IBM will present two highly popular IoT sessions, which will take place November 4-6, 2014 at the Santa Clara Convention Center in Santa Clara, Calif...
The Internet of Things (IoT) promises to evolve the way the world does business; however, understanding how to apply it to your company can be a mystery. Most people struggle with understanding the potential business uses or tend to get caught up in the technology, resulting in solutions that fail to meet even minimum business goals. In his session at Internet of @ThingsExpo, Jesse Shiah, CEO / President / Co-Founder of AgilePoint Inc., will show what is needed to leverage the IoT to transform your business. He will discuss opportunities and challenges ahead for the IoT from a market and tec...
SYS-CON Events announced today that TeleStax, the main sponsor of Mobicents, will exhibit at Internet of @ThingsExpo, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. TeleStax provides Open Source Communications software and services that facilitate the shift from legacy SS7 based IN networks to IP based LTE and IMS networks hosted on private (on-premise), hybrid or public clouds. TeleStax products include Restcomm, JSLEE, SMSC Gateway, USSD Gateway, SS7 Resource Adaptors, SIP Servlets, Rich Multimedia Services, Presence Services/RCS, Diame...
From a software development perspective IoT is about programming "things," about connecting them with each other or integrating them with existing applications. In his session at @ThingsExpo, Yakov Fain, co-founder of Farata Systems and SuranceBay, will show you how small IoT-enabled devices from multiple manufacturers can be integrated into the workflow of an enterprise application. This is a practical demo of building a framework and components in HTML/Java/Mobile technologies to serve as a platform that can integrate new devices as they become available on the market.
SYS-CON Events announced today that O'Reilly Media has been named “Media Sponsor” of SYS-CON's 15th International Cloud Expo®, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. O'Reilly Media spreads the knowledge of innovators through its books, online services, magazines, and conferences. Since 1978, O'Reilly Media has been a chronicler and catalyst of cutting-edge development, homing in on the technology trends that really matter and spurring their adoption by amplifying "faint signals" from the alpha geeks who are creating the future. An...
SYS-CON Events announced today that Aria Systems, the recurring revenue expert, has been named "Bronze Sponsor" of SYS-CON's 15th International Cloud Expo®, which will take place on November 4-6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Aria Systems helps leading businesses connect their customers with the products and services they love. Industry leaders like Pitney Bowes, Experian, AAA NCNU, VMware, HootSuite and many others choose Aria to power their recurring revenue business and deliver exceptional experiences to their customers.
The Transparent Cloud-computing Consortium (abbreviation: T-Cloud Consortium) will conduct research activities into changes in the computing model as a result of collaboration between "device" and "cloud" and the creation of new value and markets through organic data processing High speed and high quality networks, and dramatic improvements in computer processing capabilities, have greatly changed the nature of applications and made the storing and processing of data on the network commonplace.
The Internet of Things (IoT) is going to require a new way of thinking and of developing software for speed, security and innovation. This requires IT leaders to balance business as usual while anticipating for the next market and technology trends. Cloud provides the right IT asset portfolio to help today’s IT leaders manage the old and prepare for the new. Today the cloud conversation is evolving from private and public to hybrid. This session will provide use cases and insights to reinforce the value of the network in helping organizations to maximize their company’s cloud experience.
As a disruptive technology, Web Real-Time Communication (WebRTC), which is an emerging standard of web communications, is redefining how brands and consumers communicate in real time. The on-going narrative around WebRTC has largely been around incorporating video, audio and chat functions to apps. In his session at Internet of @ThingsExpo, Alex Gouaillard, Founder and CTO of Temasys Communications, will look at a fourth element – data channels – and talk about its potential to move WebRTC beyond browsers and into the Internet of Things.
SYS-CON Events announced today that Gigaom Research has been named "Media Sponsor" of SYS-CON's 15th International Cloud Expo®, which will take place on November 4-6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Ashar Baig, Research Director, Cloud, at Gigaom Research, will also lead a Power Panel on the topic "Choosing the Right Cloud Option." Gigaom Research provides timely, in-depth analysis of emerging technologies for individual and corporate subscribers. Gigaom Research's network of 200+ independent analysts provides new content daily that bridges the gap between break...
We certainly live in interesting technological times. And no more interesting than the current competing IoT standards for connectivity. Various standards bodies, approaches, and ecosystems are vying for mindshare and positioning for a competitive edge. It is clear that when the dust settles, we will have new protocols, evolved protocols, that will change the way we interact with devices and infrastructure. We will also have evolved web protocols, like HTTP/2, that will be changing the very core of our infrastructures. At the same time, we have old approaches made new again like micro-services...
The Industrial Internet revolution is now underway, enabled by connected machines and billions of devices that communicate and collaborate. The massive amounts of Big Data requiring real-time analysis is flooding legacy IT systems and giving way to cloud environments that can handle the unpredictable workloads. Yet many barriers remain until we can fully realize the opportunities and benefits from the convergence of machines and devices with Big Data and the cloud, including interoperability, data security and privacy.
Swiss innovators dizmo Inc. launches its ground-breaking software, which turns any digital surface into an immersive platform. The dizmo platform seamlessly connects digital and physical objects in the home and at the workplace. Dizmo breaks down traditional boundaries between device, operating systems, apps and software, transforming the way users work, play and live. It supports orchestration and collaboration in an unparalleled way enabling any data to instantaneously be accessed on any surface, anywhere and made interactive. Dizmo brings fantasies as seen in Sci-fi movies such as Iro...