Home > Articles > Mobile Application Development & Programming

  • Print
  • + Share This
This chapter is from the book

Using Declared Properties

One of the most significant new features of Objective-C 2.0 was the introduction of declared properties. The concept is quite simple and eliminates a great deal of tedious typing for developers. The feature is best demonstrated by showing before-and-after examples.

Declaring a Property

Listing 3.1 shows a typical interface using legacy syntax. This is the .h file, and it contains the interface in a section starting with the compiler directive @interface. @ always introduces compiler directives; note the @end at the end of the file. Interface code can appear in other places, but the .h file for a class is the primary place.

Listing 3.1 Legacy Class Declaration

//
//  My_First_ProjectAppDelegate.h
//  My First Project
//
//  Created by Sams on 6/14/11.
//  Copyright 2011 __MyCompanyName__. All rights reserved.
//

#import <Cocoa/Cocoa.h>

@interface My_First_ProjectAppDelegate : NSObject <NSApplicationDelegate> {
@private
  NSWindow *window;
}

- (IBAction)saveAction:sender;
@end

The class shown here, My_First_ProjectAppDelegate, has an interface with one variable. After that, a single method, (IBAction)saveAction:sender, is declared. By convention, variable names that begin with underscores are private and should not be used directly. Also, note that all the variables are references—the * indicates that at runtime, a reference to the underlying object's structure is to be used and resolved as needed. The @private directive means that these variables are private to this class; by contrast, @protected would allow descendants of this class to use them. @public, which is rarely used (and which is considered poor syntax), allows any object to access these variables directly. This syntax is described later in this hour.

As you can see, there is no method declared that will allow another object to access the data inside this object. Listing 3.2 adds accessor methods to access the data. These are referred to generally as accessors and specifically as getters or setters. By using this coding best practice, the variables are encapsulated and can be accessed only through these methods.

Listing 3.2 Legacy Class Declaration with Accessors

//
//  My_First_ProjectAppDelegate.h
//  My First Project
//
//  Created by Sams on 6/14/11.
//  Copyright 2011 __MyCompanyName__. All rights reserved.
//

#import <Cocoa/Cocoa.h>

@interface My_First_ProjectAppDelegate : NSObject <NSApplicationDelegate> {
@private
  NSWindow *window;
}

- (NSWindow*) getWindow;
- (NSWindow*) setWindow: (NSWindow*)newindow;

- (IBAction)saveAction:sender;
@end

Listing 3.3 demonstrates the use of declared properties in Objective C 2.0.

Listing 3.3 Modern Class Declaration

//
//  My_First_ProjectAppDelegate.h
//  My First Project
//
//  Created by Sams on 6/14/11.
//  Copyright 2011 __MyCompanyName__. All rights reserved.
//

#import <Cocoa/Cocoa.h>

@interface My_First_ProjectAppDelegate : NSObject <NSApplicationDelegate> {
}

@property NSWindow* window;

- (IBAction)saveAction:sender;
@end

The individual declarations of the variables are gone; they are replaced by declared properties that are implemented with compiler directives. As compiler directives, these are merely instructions to the compiler. They are not part of the program's syntax.

Synthesizing a Property

A declared property directive works together with a companion synthesize directive that appears in the implementation file. The companion synthesize directive to the property declaration is shown in Listing 3.4.

Listing 3.4 Synthesize Directives to Match Listing 3.3

@synthesize window;

When the program is compiled, these two directives generate code. If, as in Listing 3.3, the variables are not declared, the declarations are created. They will look just like the code that has been typed into Listings 3.1 and 3.2. In addition, getters and setters will be automatically generated. They will look exactly like those typed at the bottom of Listing 3.2.

And, perhaps most important, the declared properties allow for the use of dot syntax that automatically invokes the relevant accessors. It also provides the appearance of direct access to the encapsulated data of the object. Given the code in Listings 3.3 and 3.4, you could write the following code to reference the data within an object of type My_First_ProjectAppDelegate that has been instantiated with the name jf_My_First_ProjectAppDelegate:

jf_ My_First_ProjectAppDelegate.managedObjectContext

The appropriate accessor (getter or setter) will be invoked as needed. Note that within the implementation code of an object, you can always use self to refer to the object itself. Thus, you can write

self.managedObjectContext = <another managedObjectContext>;

Or

<myManagedObjectContext > = self.managedObjectContext;

You save a great deal of typing and make your code much more readable by using declared properties.

You can still declare the variables if you want to. At compile time, the same-named variables you have declared will be accessed by the property. However, a common use of properties is to reinforce the hiding of internal variables. The property declaration can provide a name that is used by programmers while the underlying variable is not accessed. This is common in the framework code you deal with.

For example, here is a declaration of a private variable:

NSWindow *__window;

Here is a companion property declaration:

@property nonatomic, retain, readonly NSWindow* window;

The synthesize directive would normally create the window variable because there is none. However, you can use the following synthesize directive to have the property's accessors, which are created during compilation by the synthesize directive, point to __window if you have declared it, as shown in Listing 3.5.

Listing 3.5 Using a Private Variable in a Property

@synthesize window = __window;

You can access the private variable by using its name if you are allowed to do so, which in practice generally means for code in the class itself. Thus, you can write:

__window = <something>;

Using dot syntax, you go through the property and, as a result, the following code can have the same effect:

self.window = <something>;

In practice, synthesize directives usually are a bit more complex. You can provide attributes by placing them in parentheses after the property directive. A common set of attributes in a synthesize directive is the following:

property (nonatomic, strong, readonly)
  NSPersistentStoreCoordinator *persistentStoreCoordinator;

Attributes reflect the reality of today's environment and the features of modern Objective-C. It is no longer enough to know that a variable is of a specific type. Many other attributes come into play, and the property directive allows you to set them. Its syntax also allows for the expansion of attributes in the future as the language evolves. Thus, property directives together with the appropriate attributes combine to create rich, useful objects that are easy to use and maintain over the lifespan of the app.

Table 3.1 shows the current set of attributes and the available values. The default values (having a synthesize directive create the accessors, assign, and atomic) are most commonly used. Notice also that the opposite of the atomic attribute is to omit it—in other words, there is no separate "nonatomic" attribute. (Over time, these attributes have changed to add new features. Consult the release notes for new versions of Xcode for these changes.)

Table 3.1. Attributes for Declared Properties

Attribute

Values

Notes

Accessor

getter = <name of your getter>

Accessors are synthesized for you unless you provide your own.

setter = <name of your setter>

You can go further by specifying your own custom accessors. You will have to write them, but it might be worthwhile in special cases.

Writability

readwrite

readonly

Setter

assign (default)

Semantics

retain

Retains the object after assignment and releases the previous value.

copy

Copies the object and releases the previous value.

Atomicity

nonatomic

Default is atomic so that getters and setters are thread-safe.

Using Dynamic Properties

Instead of a synthesize directive, you can use a dynamic directive for any property. The format is as follows:

@dynamic myValue;

The dynamic directive indicates that your code is going to be providing the appropriate values for the property at runtime. This entails writing some rather complex code, but there is an alternative. Core Data implements the functionality promised by the dynamic directive, so you do not have to worry—just keep reading.

  • + Share This
  • 🔖 Save To Your Account

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