Home > Articles

Encapsulation

What should be apparent from Figure 3.1 is that we have bundled everything about the class into a nice, neat package. We formally define everything that the outside world needs to know about this class in terms of these properties and methods. We call the public properties and methods of a class its interface, which represents the concept of encapsulation. In the real-world account example, a customer does not necessarily need to know how the current balance is calculated based on transactions that are added, modified, or deleted. They just need to know their current balance. Similarly, users of the account class do not need to know how the class calculates the current balance either—just that the class properly handles it when the transaction processing methods are called. Thus, we can say that encapsulation has the effect of information hiding and the definition of narrow interfaces into the class. This concept is critical to the development of robust, maintainable applications.

A class might implement internal methods and properties but choose not to expose them to the outside world through its interface. Because of this, we are free to change the internal workings of these private items without affecting how the outside world uses our class through its public interface. Figure 3.2 shows how a public method calls a private method to perform a calculation that updates the value of a public property.

Figure 3.2 The interactions between public and private methods and properties.

Suppose, for the sake of argument, we were to expose the internal function (also known as a private method) that calculates current balances. We would do this by defining it to be public versus private. An application using this class, for whatever reason, might deem it acceptable to call this internal method directly and does so in a multitude of places. Now suppose that we must change the calling convention of this method by adding a new parameter to the parameter list, such that we have to modify every piece of software that references this internal method. Assume also that the public transaction methods would not have had to change, only the formerly private method. We have effectively forced ourselves into a potentially large code rewrite, debug, test, and deployment cycle that we could have otherwise handled simply within the object's private methods while leaving the public interface intact. We will see, in the COM model discussion to follow, that we can easily modify only the class and redeploy it across the user base with a minimum of effort. In the corporate world, this translates into time and money.

Because the term interface might be a difficult concept to grasp at first, it might be easier to think of as an electrical socket. In the 220-volt parts of the world, there are three-pronged sockets with one of the prongs oriented 90 degrees out from the other two. In the 110-volt parts of the world, there are two- and three-pronged plugs with a different geometry such that you cannot plug a 110-volt oriented plug into a 220-volt socket and vice-versa. Imagine if the 110-volt world suddenly began using 220-volt–style plugs and sockets (assuming voltage will not change). We would have to replace the plug on every electrical device along with all the wall sockets. It would be a huge mess. The same goes for properties and methods. After we define the interfaces of a class and write applications against them, making changes becomes difficult and costly.

TIP

When defining a class, assume every method is to be defined as private in scope (that is, hidden) unless there is good reason to make it public. When making a method public, take steps to ensure the stability of the calling convention (that is, the parameter list) over the life of the application. Use optional parameters as necessary to cover anticipated future needs.

Encapsulation also has the effect of protecting the integrity of objects, which are instantiated using the class definition. We have already touched on this when we stated that a class is responsible for its own inner workings. Outsiders cannot meddle in its internal affairs. Similarly, property definitions can be implemented such that the class rejects invalid property states during the setting process. For example, a date-based property could reject a date literal, such as "June 31, 1997," because it does not constitute a date on any calendar. Again, because the validation logic is contained within the class definition itself, modifying it to meet changing business needs occurs in a single place rather than throughout the application base. This aspect of encapsulation is important, especially for enterprise applications, when we discuss the implementation of validation logic in Chapter 9, "A Two-Part, Distributed Business Object." It further adds to our ability to develop robust, maintainable, and extensible applications.

NOTE

One of the common comments that newcomers to object-oriented development make is that it seems like unnecessary effort to package data and functionality together into a unit called a class. It also seems like extra work to define properties and methods, deciding what is to be public and what is to be private. It is much easier to just take a seat behind the keyboard and begin banging out some code. Although it is true that object-oriented development requires a different mindset and a somewhat formal approach to analysis and design, it is this formalization process that leads to less complex development over the long term. The old saying "penny-wise and dollar-foolish" applies here because some time saved up front will lead to potentially huge problems further into the development, and worse yet, the application launch process.

Let us switch gears by defining a class with some complexity—with a financial bond—so we can illustrate some other points and begin setting the stage for other features of object-orientation. Let us call it CBond (for Class Bond). We define several properties in tabular form in Table 3.1, methods in Table 3.2, and we provide a graphical depiction in Figure 3.3.

Table 3.1 Properties of a CBond Class

Property

Data Type

Description

Name

String

The descriptive name of the bond.

FaceValue

Single (Currency)

The final redemption value of the bond.

PurchasePrice

Single (Currency)

The price to purchase the bond.

CouponRate

Single (Percent)

The yearly bond coupon payment as a percentage of its face value.

BondTerm

Integer

The length of time to maturity for the bond, expressed in years, in the primary market.

BondType

Integer: (Enumeration[CouponBond, DiscountBond, ConsolBond])

The bond type used to drive calculation algorithms.


Table 3.2 Methods of a CBond Class

Method

Description

YieldToMaturity

Calculates the interest rate that equates the present value of the coupon payments over the life of the bond to its value today. Used in the secondary bond market.

BondPrice

Calculates the bond price as the sum of the present values of all the payments for the bond.

CurrentYield

Calculates the current yield as an approximation of the yield to maturity using a simplified formula. Note: Available only on CouponBond types.

DiscountYield

Calculates the discount yield based on the percentage gain on the face value of a bond and the remaining days to maturity.


Each method uses one or more of the public property values to perform the calculation. Some methods require additional information in the form of its parameter list, as can be seen in Figure 3.3. As you might guess, the BondType property helps each method determine how to perform the calculation. A sample Visual Basic implementation of the BondPrice method might be as follows in Listing 3.1.

Figure 3.3 UML representation of a CBond class.

Listing 3.1 The BondPrice Method

Public Function BondPrice(IntRate as Single) as Single
 Dim CouponPayment as Single
 Dim j as integer
 Dim p as single
 CouponPayment = CouponRate * FaceValue
 Select Case BondType
 Case btCouponBond
  For j = 1 to BondTerm
  p = p + CouponPayment/(1 + IntRate)^j   
  Next j
  p = p + FinalValue/(1 + IntRate)^BondTerm
  BondPrice = p
 Case btDiscountBond
  BondPrice = FaceValue/(1 + IntRate)
 Case btConsolBond
  BondPrice = CouponPayment/IntRate
 End Select
End Sub

As you can see, each value of the BondType property requires a different use of the properties to perform the correct calculation. The application using the class is not concerned with how the method performs the calculation, but only with the result. Now suppose that you need to modify the calculation algorithm for the BondPrice method. Because of encapsulation, you only need to modify the contents of the BondPrice method and nothing more. Better yet, because you have not changed the calling convention, the applications using the CBond class are none the wiser that a change occurred.

 

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020