Home > Store

Design by Contract, by Example

Register your product to gain access to bonus material or receive a coupon.

Design by Contract, by Example

Book

  • Sorry, this book is no longer in print.
Not for Sale

Description

  • Copyright 2002
  • Dimensions: 7-3/8x9-1/4
  • Pages: 256
  • Edition: 1st
  • Book
  • ISBN-10: 0-201-63460-0
  • ISBN-13: 978-0-201-63460-0

Design by contract is an underused--but powerful--aspect of the object-oriented software development environment. With roots in the Eiffel programming language, it has withstood the test of time, and found utility with other programming languages. Here, by using both the Eiffel and Java languages as guidance, Design by Contract, by Example paves the way to learning this powerful concept.

Through the following six teaching principles, the authors demonstrate how to write effective contracts and supporting guidelines. Readers will learn how to:

  1. Separate queries from commands
  2. Separate basic queries from derived queries
  3. Write a postcondition for each derived query that specifies what result can be returned
  4. Write a postcondition for each command that specifies the value of every basic query
  5. Decide on a suitable precondition for every query and command
  6. Write invariants to define unchanging properties of objects

Contracts are built of assertions, which are used to express preconditions, postconditions and invariants. Using the above principles, the authors provide a frank discussion of the benefits, as well as the potential drawbacks, of this programming concept. Insightful examples from both the Eiffel and Java programming languages are included, and the book concludes with a summary of design by contract principles and a cost-benefit analysis of their applications.

Design by Contract, by Example is the first book of its kind to offer an example-based approach to learning this important paradigm. If you are a developer seeking a way to improve your craft, this book will give you the necessary understanding of the concepts of contracts in software design.



0201634600B08142001

Sample Content

Online Sample Chapter

A First Taste of Design by Contract

Downloadable Sample Chapter

Click below for Sample Chapter related to this title:
mitchellch01.pdf

Table of Contents



Foreword.


Preface.


1. A First Taste of Design by Contract.

About This Chapter.

The Customer Manager Example.

Some Questions.

A Contract for CUSTOMER_MANAGER.

The Story So Far.

Runtime Checking.

Trustworthy Documentation.

Summary.

An Aide Memoire.

Things to Do.



2. Elementary Principles of Design by Contract.

About This Chapter.

Stacks.

Separate Commands and Queries.

Naming Conventions.

Separate Basic Queries and Derived Queries.

Specify How Commands Affect Basic Queries.

Capture Unchanging Properties in Invariants.

The Class and Its Contract.

The Basic Queries Are a Conceptual Model of Stacks.

The Six Principles.

Things to Do.



3. Applying the Six Principles.

About This Chapter.

Dictionaries.

Separating and Categorizing Features.

Postconditions.

Preconditions.

Invariant.

A Complete, Contract-Level View of DICTIONARY.

Summary.

Things to Do.



4. Building Support for Contracts—Immutable Lists.

About This Chapter.

Support for Linear Structures.

Contracts Involve Expressions.

Immutable Lists.

A Contract for Immutable Lists.

The Basic Queries.

The Creation Command.

The Derived Query Count.

The Derived Query Preceded_by.

The Derived Query Item.

The Derived Query is_equal.

The Derived Query Sublist.

Summary.

Things to Do.



5. Applying the Six Principles to QUEUE.

About This Chapter.

Queues.

A Contract for the Remove Feature.

Making Count a Derived Feature.

A Contract for the Initialize Feature.

A Contract for the Head Feature.

A Contract for the put Feature.

More Derived Queries.

Summary.

Things to Do.



6. Design by Contract and Inheritance.

About This Chapter.

Superclasses and Subclasses.

Redefining Contracts.

Eiffel Syntax.

Summary.

Invariants and Inheritance.

Designing Superclasses with Guarded Postconditions.

Two Kinds of Inheritance.

Summary.

Things to Do.



7. Frame Rules.

About This Chapter.

Change Specifications and Frame Rules.

Frame Rules for put Using Immutable Lists.

Frame Rules for put Using “Forall”.

Kinds of Frame Rules.

Things to Do.

Appendix: More About the Preprocessor.



8. Benefits of Design by Contract.

About This Chapter.

Kinds of Benefits.

Better Designs.

Improved Reliability.

Better Documentation.

Easier Debugging.

Support for Reuse.

Design by Contract and Defensive Programming.

Defending a Program Against Unwanted Input.

Bulletproofing a Routine.

Defensive Programming.

Some Costs and Limitations of Contracts.



9. Contracts for an Observer Framework.

About This Chapter.

The Observer Framework.

Immutable Sets.

Attaching and Detaching Observers.

Notification (For One Observer).

Notification (For All Observers).

A Performance Issue.

Frame Rules.

Privacy.

Things to Do.



10. Fulfilling a Precondition.

About This Chapter.

The Examples.

Fulfilling and Testing a Precondition.

Testing Versus Checking.

A Simple Counter Class.

The User's View of the Program.

The Internal Structure of the Program.

The Program's Behavior.

A Minor Detail.

Summary.

Things to Do.



11. Java Examples.

About This Chapter.

Why Java?

Queues.

The Basic Query size().

The Basic Query get().

The Derived Query head().

The Derived Query isEmpty().

The Derived Query shallowCopy().

The Constructor Queue.

The Command put.

The Command remove.

Summary.

Dictionaries.

Names.

The Invariant.

The Basic Queries.

A Derived Query.

The Commands.

The Constructor.

A Possible Set of Classes.

Java Without iContract.

Precondition Testing.

Things to Do.



12. Analysis by Contract.

About This Chapter.

A Use Case.

Contracts in Analysis Models.

A Contract for the withdrawCash Use Case.

From Analysis to Design.

Problem Domain and System Models.

The Object Constraint Language.

Summary.



Bibliography.


Index. 0201634600T10102001

Preface

WHAT THE BOOK COVERS

Design by contract is all about adding assertions to object-oriented programs, at the design and coding stages. Assertions are facts about a program that must be true for the program to be bug-free. The key assertions in design by contract define preconditions, postconditions, and invariants:

  • A precondition is a condition on a method specifying what must be true for it to be valid to call the method.
  • A postcondition is a condition on a method specifying what will become true when the method successfully completes.
  • An invariant is a condition on a whole class specifying what is true about any object of the class whenever you can call a method on that object.

The assertions are written in a programming language, so that

  • They make sense to programmers, providing good, helpful documentation.
  • They can be checked at runtime, providing support for testing and debugging.

This book concentrates on showing you how to write good contracts. The book presents six principles for writing good contracts, and some supporting guidelines. Through examples, the book motivates the principles and guidelines and shows them in use.

After studying the first three chapters, you will be in a position to write high-quality contracts. The rest of the book will help you do even better.

In addition to chapters that develop contracts for individual example classes, there are chapters on contracts in relation to inheritance and on the topic of frame rules (contracts that assert what does not change). Two larger examples towards the end of the book involve developing contracts across more than one class. Chapter 9 concerns the Observer pattern from Gamma et al. 1994, and Chapter 10 presents a small application in which an object in the user interface is shown to respect part of a contract in the heart of the application. Chapter 12 discusses the use of contracts in systems analysis. Chapter 8 reviews the benefits of using contracts and compares design by contract to defensive programming. Chapter 11 explores how to attach contracts to interfaces and explores briefly how you might implement contracts in a distributed environment.

PROGRAMMING LANGUAGES

The examples are presented first in the object-oriented programming language Eiffel. We chose Eiffel for three reasons:

  1. Eiffel has built-in support for contracts, so it is excellent for showing the concepts at work.
  2. Eiffel is easy to read, so it's a good pseudo-code from which you can implement the ideas in any object-oriented programming language.
  3. Commercial-strength compilers are available for Eiffel, so our contracts can play both their intended roles, as specifications and as checks. A contract is a specification of a class, describing precisely what services the class delivers. The assertions in a contract can be evaluated at runtime to check that the implementing code is consistent with its specification.

You don't have to be an Eiffel programmer to follow the examples. We are sure you'll be able to carry the principles over to your own programming environment. The issues we raise, and the advice we give, are not specific to Eiffel.

We do rework two of our examples in Java, using a preprocessor (called iContract) that provides support for contracts. This allows us to explore some issues that do not arise so directly in Eiffel and to show you contracts in another language.

WHO THE BOOK IS FOR

The book is written for anyone who wants to find out how to write good contracts. We intend it to be useful to practitioners, students (especially the early chapters), teachers, and researchers.

We don't believe the book is one you can curl up with by the fire (in winter) or the pool (in summer) and read your way through. We believe its material has to be studied and, most importantly, tried out. We hope you have access to a programming environment that supports contracts, such as a Java compiler and the iContract tool (see the bibliography for more information) or an Eiffel compiler (again, more information in the bibliography).

We do not teach object-oriented programming. We assume you know how to program in some object-oriented programming language. We have tried to give enough explanation of the Eiffel and Java code that those familiar with other OO languages can follow the examples.

STYLE

The book is based firmly on examples. Usually, a chapter is based on a single example. This means that there is quite a lot of code to wade through at times. However, most of the code is at the level of assertions, which define what a piece of program achieves. This level of code is generally easier to understand than the code that defines how a piece of program achieves its goal. In addition, we usually dissect the code a few lines at a time to make it easier to follow the discussion.

The examples are mostly simple ones. For example, instead of writing full contracts for the customer manager component introduced in Chapter 1, we write them for a look-up table (or dictionary), which is the data structure that underpins the customer manager component. That way, you won't get lost in too many details, and you won't lose sight of the basic principles. Once you see the principles, we are confident you'll be able to apply them to your own, more complicated examples.

We have been selective in what we put into this book. Other books have useful and insightful things to say on the subject of design by contract, but we have concentrated on what makes this book different--the advice it gives on how to write good contracts.

And, of course, this book is not the end of the story of design by contract. There is more work to be done on writing contracts, on developing the underlying technology and the underlying theory, on applying the ideas in broader contexts, and on assessing the benefits in practice.

WEB SITE

There is a Web site associated with the book. It contains the source code of the examples. Our hope is that you will download the code and play with it. Change the code. Add bugs, both in the implementation and in the contracts, and see what happens. Change the examples into new ones. Experiment. Use them on real projects. That's how we learned about contracts.



0201634600P12122001

Index

A
a_capacity argument, 91-92
Abstract classes, 158
ABSTRACT_SUBJECT class, 162
Account type, 219-220
add feature, 5-8, 10, 12
add_customer feature, 11
all_observers_up_to_date function, 158-159
Ampersands (&) in Java, 193
AN_INQUISITIVE_CLIENT class, 40-42
Analysis by contract, 215
design from, 220-221
models for, 217
object constraint language in, 224-225
problem domains and system models in, 221-224
summary, 225-226
use case, 215-216
withdrawCash case, 216-220
And operations
for assertions, 26
in Java, 193
and then operator, 59, 107, 112-113
Arguments in signatures, 7
Assertion-checking for documentation, 141
Assertions
as expressions, 70-71
multiple, 26
redundancy of, 36
Associations between components, 2
ATM example, 215-219
attached queries
in ABSTRACT_OBSERVER, 160-161
for observers, 156
Attaching observers, 151-152, 155-156
Attributes, 3
contracts on, 89
features as, 21
invariants for, 91
queries as, 20
types of, 4
B
Balances for Account, 219-220
BASIC_CUSTOMER_DETAILS type, 4-5
Basic queries
as conceptual models, 38-42
in DICTIONARY, 200-201
frame rules for, 131
for immutable lists, 72-73
separating from derived queries, 23-25
Benefits
in DIFFERENT_COURIER, 101
kinds of, 137-138
Black diamonds for associations, 2
Boolean queries, 23
Bulletproofing, 144-145
Buttons, grayed out, 175-176, 178, 183
C
Calling features, 6
Capacity
frame rule concerning, 122
of queues, 83-84, 92
Capital letters in Java, 200
change_customer feature, 13
Change specifications and frame rules, 119-121
Cheap-to-calculate queries, 160
Checking vs. testing of preconditions, 172-173
choice queries, 154
Clarity
of designs, 138-139
of documentation, 141
Class interfaces, 36, 198
Classes
abstract, 158
contracts for, 36-38
for frame rule constraints, 163
generic, 18
in Java, 198
short form of, 112, 198
superclasses and subclasses, 99-100
CLIENT class, 101
client_version_of_item_at feature, 40-42
clone queries, 154
Code reuse, 117
Commands
postconditions for, 26-34
preconditions for, 34
separating from queries, 19-22
for stacks, 18
Comments
for constraints, 146
for features, 7
in Java, 193, 202
tagged, 194
Components, 2
Conceptual models, basic queries as, 38-42
CONCRETE_SUBJECT class, 162
Concurrent programs, 147-148
Constraints, 58-59. See also Preconditions, Postconditions, and Invariants
for attributes, invariants for, 91
for frame rules, separate classes for, 163
on queries, 61-62
Constructors
for DICTIONARY, 202-203
in Java, 199
for Queue, 195
Contents in equal lists, 126
Contracts
analysis by. See Analysis by contract
on attributes, 89
for classes, 36-38
on functions, 89
redefining, 100-105
rights in, 14
Costs and limitations, 146-148
count method, 5, 7, 10
count_never_negative invariant, 35
count queries, 23
in IMMUTABLE_LIST, 74
in IMMUTABLE_SET, 154
in initialize, 27, 29-31, 62
invariants for, 34, 62-63
in NAME_LIST, 110
postconditions for, 11
preconditions for, 11, 57
in put, 26, 29, 34, 62
in QUEUE, 85, 87-91
for queues, 84
in RELAXED_NAME_LIST, 113
in remove, 28, 32, 34-35, 62-63
in SIMPLE_STACK, 24, 37
for stacks, 18
COUNTER class example, 173-174
behavior of, 178-184
internal structure, 176-177
user view, 174-176
COURIER class, 100-101, 106, 108
creation commands, 36
frame rules for, 130
for immutable lists, 74
Customer Manager example, 2-5
adding customers in, 6-8
contract for, 6-9
customer names in, 8-9
listing, 9-11
methods in, 5-6
runtime checking, 11-13
trustworthy documentation for, 13-14
CUSTOMER type, 2-3
CUSTOMER_MANAGER type, 2-3
D
Debugging support, 142
DECREMENT_BUTTON class, 176-180, 183
decrement command, 174-178, 181, 183
deep_clone feature, 126
deep_equal feature, 126
Defensive programming, 143
and bulletproofing, 144-145
example, 145-146
for unwanted input, 143-144
Deferred classes, 158
delete feature for STACK, 20
deliver service, 100-105
Derived queries
postconditions for, 25
separating from basic queries, 23-25
Design improvements as benefit, 138-139
Design patterns, 150
Detaching observers, 152, 155-156
Development, debugging support in, 142
Dictionaries, 2, 47-48
in Java, 199-200
separating features in, 48-49
DICTIONARY class, 48-49
contractual-level view of, 63-65
exercises, 66-67
invariants in, 62-63
in Java, 198-199
basic queries in, 200-201
commands in, 201-202
constructors for, 202-203
derived queries in, 201
invariants in, 200
for names, 199-200
set of, 203
postconditions for, 50-56
preconditions for, 56-62
summary, 65-66
DictionaryFactory class, 203-204
DictionaryUsingMap class, 203-204
DIFFERENT_COURIER subclass, 101-108
Directories, 2
Disabling buttons, 178-183
Distributed programs, 147-148
Documentation
as benefit, 140-141
for constraints, 146
for Customer Manager example, 13-14
E
Eiffel language
attribute types in, 4
contract syntax in, 11
libraries in, 22
names in, 5
short form of classes in, 198
subclass syntax in, 104-107
Void references in, 58-60
emptyQueue command, 211
Enabled state, 180-181
Enabling buttons, 178-183
end keyword, 104
ensure keyword
for postconditions, 7-8
in redefined contracts, 105
@ensure tag, 194
ensure then operation, 107, 112
Equal signs (=)
for equality tests, 7
in Java, 194
Equality
of lists, 123-126
of strings, 9
Exceptions
raised, 145-146
systematic use of, 139
Explicit conceptual models, 40
Expressions, 70-71
F
Factory class, 202
feature keyword, 36-37, 40
Features, 2
as attributes and routines, 21
contracts for, 6
mixed, 22
obligations of, 14
separating, 48-49
signatures for, 7
Flat-short form of classes, 112
forall operator
frame rules for, 128-129
preprocessor for, 132-135
in removing items, 197
in shallow copies, 195
Frame rules, 119
and change specifications, 119-121
constraints for, separate classes for, 163
exercises, 132, 166-167
for forall, 128-129
kinds of, 130-132
for observer framework, 161-163
for put, 121-127
from_position feature, 79-80
Fulfilling preconditions, 169-170
COUNTER class example, 173-174
behavior of, 178-184
internal structure, 176-177
user view, 1

Updates

Submit Errata

More Information

Unlimited one-month access with your purchase
Free Safari Membership