Welcome!

Java IoT Authors: Pat Romanski, Yeshim Deniz, Elizabeth White, Liz McMillan, Paul Simmons

Related Topics: Java IoT

Java IoT: Article

Reflection & Introspection: Objects Exposed

Reflection & Introspection: Objects Exposed

One of the salient aspects of the Java language is the control it gives to developers for dynamically generating and reusing code. This allows the language to offer Java programmers the ability to write code in which the actual behavior is determined at runtime. Of the eleven buzzwords used to define Java, this article is going to focus on the dynamic nature of the Java programming language.

One of the salient aspects of the Java language is the control it gives to developers for dynamically generating and reusing code. This allows the language to offer Java programmers the ability to write code in which the actual behavior is determined at runtime. Of the eleven buzzwords used to define Java, this article is going to focus on the dynamic nature of the Java programming language.Introspection Uses Reflection
Reflection and introspection are very closely related. Reflection is a low-level facility that allows the code to examine the internals of any class or object at runtime. Introspection builds on this facility and provides a more convenient interface for examining Beans. In fact, the relationship between reflection and introspection is very similar to the relationship between JavaBeans and other Java classes. JavaBeans are simply normal Java objects with certain design patterns enforced in their nomenclature. Introspection assumes these design patterns on the object that it is inspecting and uses low-level reflection to examine the object's internals.

The Reflection API
The Reflection API became a part of core Java with release 1.1 of the JDK. The API is defined across the following:

  • The new methods added to the java.lang.Class class in JDK 1.1
  • The java.lang.reflect package defined in JDK1.1

    The class java.lang.Class contains methods that return instances of classes/interfaces defined in the java.lang.reflect package. A detailed description of the API is beyond the scope of this article and can be found in any standard Java text. However, the classes that comprise the Reflection API are listed in Table 1.

    The Introspection API
    The Introspection API consists of several classes in the java.beans package. Again, a detailed description of the API is beyond the scope of this article and can be found in any standard Java text. The main classes in the Introspection API are listed in Table 2.

    The Costs of Usage
    Reflection and Introspection are powerful tools that contribute to the flexibility provided by the Java language. However, these APIs should be used only as needed and after taking into account the costs associated with their usage:

  • Reflection and Introspection method calls have a substantial performance overhead.
  • Using reflection makes the code much more complex and harder to understand than using direct method calls.
  • Errors in method invocation are discovered at runtime instead of being caught by the compiler.
  • The code becomes type-unsafe.

    The Reflection and Introspection APIs should be used only when other forms of object-oriented programming are not appropriate.

    The following examples demonstrate the use of Reflection and Introspection to develop some useful Java utilities.

    Cookie Factory
    Our first example illustrates the use of Reflection to build a utility that allows us to instantiate objects of types derived from a "Cookie" interface. The actual type of the object instantiated is determined by a String parameter, which contains the name of the actual class. The code for the example is shown in Listings 1and 2.

    Listing 1 defines the Cookie interface and the derived classes. The Cookie interface is simply a marker interface which is implemented by the classes FortuneCookie and MisFortuneCookie. Both these classes define a single static method which prints out a string and returns a new instance of the respective class.

    Listing 2 shows the CookieFactory class which is capable of producing objects derived from the "Cookie" interface. It defines a single method createCookie that takes a String parameter, className. The Class corresponding to this name is obtained from the Class class by calling

    c = Class.forName(className);

    Once we have the class, we need to obtain the method to be called on it. The name of the method is "newCookie." In this example, we are assuming that the name of the method is available at this point. The parameter types for the method are filled in an array of type Class and this is used to get the actual Method object as follows:

    method = c.getMethod("newCookie", pTypes);

    Once the Method object is available, the static method is invoked on the class after constructing an array of Objects that contains the actual parameter instances:

    cookie = (Cookie)(method.invoke(c, params));

    A simple tester for the class is provided in the main() method. This first constructs the CookieFactory and then creates instances of the FortuneCookie and MisFortuneCookie class. The output from the program is shown in Figure 3.

    An X-Ray Class
    Our second example illustrates the use of reflection to build a utility that allows us to view all the methods, constructors, fields, interfaces and inheritance for a supplied class. The class being X-rayed is specified by a String parameter which contains the name of the actual class. The code for the example is shown in Listing 4.

    In order for the X-ray class program to determine the methods, constructors, fields and interfaces contained in the requested class, it must instantiate an object of the class by calling:

    c = Class.forName(className);

    After instantiating the class, the utility determines the selected operation on that class based on a second user-supplied string parameter, which can have one of the following values:

    localMethods
    allMethods
    Constructors
    fields
    interface
    inheritance

    The local methods contained in the specified class may be found by calling:

    methodList = c.getDeclaredMethods();

    This call returns a Method[] that contains all the methods declared in the local class including private, protected and public. This call excludes inherited methods. A list of all the public methods, both inherited and local, may be obtained by calling:

    methodList = c.getMethods();

    Constructor methods are not included in the return Method[] of this call. Retrieving a list of constructors for a specific class can be accomplished by calling:

    constructorList = c.getDeclaredConstructors();

    This call returns a constructor[] that contains all of the private, protected and public constructors declared on the local class. A list that includes only the public constructors can be constructed by calling:

    constructorList = c.getConstructors();

    Class variables can be retrieved as Field[] information. To access a complete list of fields from a class including private, protected and public, we call:

    fieldList = c.getDeclaredFields();A list that includes only the public fields can be retrieved by calling:

    fieldList = c.getFields();

    Information concerning the interfaces implemented by a class can be accessed by calling:

    interfaceList = c.getInterfaces();

    This call returns a Class[] that contains all of the interfaces implemented by the local class. Notice that this call doesn't have a getDeclaredInterfaces() counterpart like the other methods.

    To access the inheritance information in the class, we get the name of each one of the superclasses in the inheritance tree. This is done in a while loop by calling:

    classRef = c.getSuperclass();

    We use this mechanism to return a class[] with all of the classes that participate in the extension of the local class. The output of the program for obtaining the inheritance hierarchy of the java.applet.Applet class is given in Figure 4.

    Notice that of the various methods presented on this section, the only method that recursively provided information contained in its inheritance tree was the c.getMethods() call. The other methods only provided information contained by the local class.

    An X-Ray Bean
    Our third example illustrates the use of Introspection to build a utility that allows us to view all the methods, properties and events for a supplied JavaBean class. The Bean being X-rayed is specified by a String parameter which contains the name of the actual Bean class. The code for the example is shown in Listing 3.

    In order for the X-ray Bean program to determine the methods, properties and events contained in the requested class, it must instantiate an object of the class by calling:

    c = Class.forName(className);

    After instantiating the class, the utility must access the BeanInfo for the instantiated Bean. BeanInfo data can be accessed via the Introspector class by calling:

    bi = Introspector.getBeanInfo(c);

    Next, the utility determines the selected operation on that class based on the second user-supplied parameter entered at the command line (i.e., methods, properties and events). The localMethods contained by the specified Bean can be found by calling:

    methodDescriptorList = bi.getMethodDescriptors();

    This call returns a MethodDescriptor[] that contains a description of all of the methods contained by this Bean. The type of method descriptor returned by this call contains a complete list of all the public methods contained within the inheritance tree of this Bean. In order to access the actual method instances, we need to iterate through the methodDescriptionList and obtain the method by calling:

    methodRef = methodDescriptorList[i].getMethod();

    From each one of these values, we are able to build a Method[] list that can be displayed by the utility. This includes no constructor method information. To access the Bean constructor information, you must use reflection.

    Bean properties can be retrieved via PropertyDescriptors by calling:

    PropertyDescriptorList = bi.getPropertyDescriptors();

    This call returns a PropertyDescriptor[] that contains a description of all of the properties contained by this Bean. This includes name, readMethod, writeMethod, type, EditorClass, etc. Our utility uses this information to get the readMethod, writeMethod and property name via the PropertyDescriptor superclass (i.e., FeatureDescriptor) by calling:

    methodRef = PropertyDescriptorList[i].getReadMethod();
    methodRef = PropertyDescriptorList[i].getWriteMethod();
    propertyName = PropertyDescriptorList[i].getName();

    Bean events can be retrieved via EventSetDescriptors by calling:

    eventSetDescriptorList = bi.getEventSetDescriptors();

    This call returns an EventSetDescriptor[] that contains a description of all the methods associated with each event for this Bean. Our utility uses this information to get a Method[] for each one of the returned events in the eventSetDescriptorList. This is accomplished by calling:

    methodList = eventSetDescriptorList[i].getListenerMethods();

    This information is used to identify the methods associated to each one of the listener methods.

    Information concerning the interfaces implemented by a class can be accessed by calling:

    interfaceList = c.getInterfaces();

    This call returns a class[] that contains all the interfaces implemented by the local class. Notice that this call doesn't have a getDeclaredInterfaces() counterpart like the other methods.

    The output from the program for examining the events in the class, com.sun.swing.Jpanel is shown in Figure 5.

    Conclusion
    In this article, we took a look at the Reflection and Introspection APIs and used them to develop several useful utilities for Java development. In our next article, we will use the concepts and utilities introduced here to develop a new category of dynamically generated adapters called Dynamic Adapters.

    The traditional Adapter design pattern is defined as follows: Adapter: "Convert the interface of a class into another interface clients expect. Adapter lets classes work together that couldn't otherwise because of incompatible interfaces." [Design Patterns: Elements of Resuable Object-Oriented Software, Gamma et. al., Addison Wesley, 1995.]

    Adapters are used when the input and output interfaces are known at compile-time. Dynamic Adapters will allow a program to dynamically map the interfaces at runtime. We will examine these patterns in more detail in the next article.

  • More Stories By Ajit Sagar

    Ajit Sagar is Associate VP, Digital Transformation Practice at Infosys Limited. A seasoned IT executive with 20+ years experience across various facts of the industry including consulting, business development, architecture and design he is architecture consulting and delivery lead for Infosys's Digital Transformation practice. He was also the Founding Editor of XML Journal and Chief Editor of Java Developer's Journal.

    Comments (0)

    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.


    @ThingsExpo Stories
    @DevOpsSummit at Cloud Expo, taking place November 12-13 in New York City, NY, is co-located with 22nd international CloudEXPO | first international DXWorldEXPO and will feature technical sessions from a rock star conference faculty and the leading industry players in the world.
    "Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    As data explodes in quantity, importance and from new sources, the need for managing and protecting data residing across physical, virtual, and cloud environments grow with it. Managing data includes protecting it, indexing and classifying it for true, long-term management, compliance and E-Discovery. Commvault can ensure this with a single pane of glass solution – whether in a private cloud, a Service Provider delivered public cloud or a hybrid cloud environment – across the heterogeneous enter...
    DXWorldEXPO LLC announced today that ICC-USA, a computer systems integrator and server manufacturing company focused on developing products and product appliances, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City. ICC is a computer systems integrator and server manufacturing company focused on developing products and product appliances to meet a wide range of ...
    More and more brands have jumped on the IoT bandwagon. We have an excess of wearables – activity trackers, smartwatches, smart glasses and sneakers, and more that track seemingly endless datapoints. However, most consumers have no idea what “IoT” means. Creating more wearables that track data shouldn't be the aim of brands; delivering meaningful, tangible relevance to their users should be. We're in a period in which the IoT pendulum is still swinging. Initially, it swung toward "smart for smart...
    Headquartered in Plainsboro, NJ, Synametrics Technologies has provided IT professionals and computer systems developers since 1997. Based on the success of their initial product offerings (WinSQL and DeltaCopy), the company continues to create and hone innovative products that help its customers get more from their computer applications, databases and infrastructure. To date, over one million users around the world have chosen Synametrics solutions to help power their accelerated business or per...
    Founded in 2000, Chetu Inc. is a global provider of customized software development solutions and IT staff augmentation services for software technology providers. By providing clients with unparalleled niche technology expertise and industry experience, Chetu has become the premiere long-term, back-end software development partner for start-ups, SMBs, and Fortune 500 companies. Chetu is headquartered in Plantation, Florida, with thirteen offices throughout the U.S. and abroad.
    In an era of historic innovation fueled by unprecedented access to data and technology, the low cost and risk of entering new markets has leveled the playing field for business. Today, any ambitious innovator can easily introduce a new application or product that can reinvent business models and transform the client experience. In their Day 2 Keynote at 19th Cloud Expo, Mercer Rowe, IBM Vice President of Strategic Alliances, and Raejeanne Skillern, Intel Vice President of Data Center Group and ...
    Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
    Bill Schmarzo, author of "Big Data: Understanding How Data Powers Big Business" and "Big Data MBA: Driving Business Strategies with Data Science," is responsible for setting the strategy and defining the Big Data service offerings and capabilities for EMC Global Services Big Data Practice. As the CTO for the Big Data Practice, he is responsible for working with organizations to help them identify where and how to start their big data journeys. He's written several white papers, is an avid blogge...
    "We are a well-established player in the application life cycle management market and we also have a very strong version control product," stated Flint Brenton, CEO of CollabNet,, in this SYS-CON.tv interview at 18th Cloud Expo at the Javits Center in New York City, NY.
    It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...
    Most people haven’t heard the word, “gamification,” even though they probably, and perhaps unwittingly, participate in it every day. Gamification is “the process of adding games or game-like elements to something (as a task) so as to encourage participation.” Further, gamification is about bringing game mechanics – rules, constructs, processes, and methods – into the real world in an effort to engage people. In his session at @ThingsExpo, Robert Endo, owner and engagement manager of Intrepid D...
    Recently, WebRTC has a lot of eyes from market. The use cases of WebRTC are expanding - video chat, online education, online health care etc. Not only for human-to-human communication, but also IoT use cases such as machine to human use cases can be seen recently. One of the typical use-case is remote camera monitoring. With WebRTC, people can have interoperability and flexibility for deploying monitoring service. However, the benefit of WebRTC for IoT is not only its convenience and interopera...
    Michael Maximilien, better known as max or Dr. Max, is a computer scientist with IBM. At IBM Research Triangle Park, he was a principal engineer for the worldwide industry point-of-sale standard: JavaPOS. At IBM Research, some highlights include pioneering research on semantic Web services, mashups, and cloud computing, and platform-as-a-service. He joined the IBM Cloud Labs in 2014 and works closely with Pivotal Inc., to help make the Cloud Found the best PaaS.
    Everything run by electricity will eventually be connected to the Internet. Get ahead of the Internet of Things revolution. In his session at @ThingsExpo, Akvelon expert and IoT industry leader Sergey Grebnov provided an educational dive into the world of managing your home, workplace and all the devices they contain with the power of machine-based AI and intelligent Bot services for a completely streamlined experience.
    Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
    Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
    Personalization has long been the holy grail of marketing. Simply stated, communicate the most relevant offer to the right person and you will increase sales. To achieve this, you must understand the individual. Consequently, digital marketers developed many ways to gather and leverage customer information to deliver targeted experiences. In his session at @ThingsExpo, Lou Casal, Founder and Principal Consultant at Practicala, discussed how the Internet of Things (IoT) has accelerated our abilit...
    In his session at Cloud Expo, Alan Winters, U.S. Head of Business Development at MobiDev, presented a success story of an entrepreneur who has both suffered through and benefited from offshore development across multiple businesses: The smart choice, or how to select the right offshore development partner Warning signs, or how to minimize chances of making the wrong choice Collaboration, or how to establish the most effective work processes Budget control, or how to maximize project result...