Instance Initialization

Provider Responsibility

How to ensure that an instance is well initialized?

This is the responsibility of the class to provide well-formed object

Automatic initialize Lazy initialization Proposing the right interface Providing a default value

S.Ducasse

A client should not make assumptions or been responsible to send specific sequence of messages to get a working object

1

A First Implementation of Packet

!"#$

!"#$

S.Ducasse

2

Packet class Definition

Object subclass: #Packet !

instanceVariableNames: ‘contents addressee originator ‘

Packet class is automatically defined ! ! Packet class ! ! instanceVariableNames: ''

Packet>>printOn: aStream ! super printOn: aStream. ! aStream nextPutAll: ‘ addressed to: ‘; nextPutAll: self addressee. ! aStream nextPutAll: ‘ with contents: ’; nextPutAll: self contents

Example of instance creation ! ! Packet new ! ! ! addressee: #mac ; ! ! ! contents: ‘hello mac’

Packet>>addressee !

^addressee

Packet>>addressee: aSymbol

S.Ducasse

!"#$

3

S.Ducasse

4

!"#$

Fragile Instance Creation

S.Ducasse

!"#$

Problems

!"#$

If we do not specify a contents, it breaks!

Responsibility of the instance creation relies on the clients

|p| p := Packet new addressee: #mac. p printOn: aStream -> error

A client can create packet without contents, without address instance variable not initialized -> error (for example, printOn:) -> system fragile

S.Ducasse

5

Fragile Instance Creation Solutions

!"#$

6

Instance Initialization

Automatic initialization of instance variables Proposing a solid interface for the creation! Lazy initialization

!"#$

How to ensure that an instance is well initialized? Automatic initialize Lazy initialization Proposing the right interface Providing a default value

S.Ducasse

7

S.Ducasse

8

Assuring Instance Variable Initialization

!"#$

The New/Initialize Couple

How to initialize a newly created instance ?

!"#$

Object>>initialize ! “do nothing. Called by new my subclasses ! override me if necessary”

Define the method initialize

!

Packet>>initialize super initialize.

^ self

contents := ‘’. addressee := #noAd

S.Ducasse

S.Ducasse

9

(VW) Assuring Instance Variable

!"#$

new calling initialize

!"#$

Problem: By default new class method returns instance with uninitialized instance variables.

Packet new ... should invoke the initialize method

In VisualWorks, initialize method is not automatically called by creation methods new/new:.

Packet class>>new | inst | inst := super new. inst initialize. ^ inst

How to initialize a newly created instance ?

S.Ducasse

10

11

S.Ducasse

12

The New/Initialize Couple

!"#$

One single method application

Define an instance method that initializes the instance variables and override new to invoke it. (1&2)! ! ! (3)! ! (4)!

! !

Packet class>>new “Class Method” ! ^ super new initialize! !

! ! !

Packet>>initialize! “Instance Method” super initialize. contents := ‘default message’

Object class Object

Node name accept: aPacket send: aPacket

Node class new withName: aString instance of

Workstation class

! Packet new (1-2) => aPacket initialize (3-4) => returning aPacket but initialized!

Workstation originate: aPacket accept: aPacket name

Reminder: You cannot access instance variables from a class

S.Ducasse

instance of

instance of aWorkstation withName: 'BigMac'

S.Ducasse

13

Instance Initialization

14

Lazy Initialization

How to ensure that an instance is well initialized?

!"#$

When some instance variables are: - not used all the time - consuming space, difficult to initialize because depending on other - need a lot of computation

Automatic initialize Lazy initialization Proposing the right interface Providing a default value

Use lazy initialization based on accessors Accessor access should be used consistently!

S.Ducasse

15

!"#$

!"#$

S.Ducasse

16

Lazy Initialization Example

!"#$

Better

A lazy initialization scheme with default value ! Packet>>contents !

!

contents isNil! ! ! ifTrue: [contents := ‘no contents’] ^ contents

contents isNil! ! ! ifTrue: [contents := ‘no contents’] ^ contents is equivalent to

Packet>>contents ^ contents ifNil: [contents := ‘no contents]

A lazy initialization scheme with computed value Dummy>>ratio !

Packet>>contents !

aPacket contents or self contents

!"#$

ratio isNil ifTrue: [ratio := self heavyComputation]

S.Ducasse

S.Ducasse

17

Instance Initialization

18

Strengthen Instance Creation Interface

How to ensure that an instance is well initialized?

Problem: A client can still create aPacket without address. Solution: Force the client to use the class interface creation.

Automatic initialize Lazy initialization Proposing the right interface Providing a default value

Providing an interface for creation and avoiding the use of new: Packet send: ‘Hello mac’ to: #Mac Packet class>>send: aString to: anAddress ^ self new contents: aString ; addressee: anAddress ; yourself

S.Ducasse

19

!"#$

S.Ducasse

20

!"#$

Examples of Instance Initialization

!"#$

Another Example

step 1. SortedCollection sortBlock: [:a :b| a name < b name]

step 1.

!

| newCollection | newCollection := self new.

^ self new sortBlock: aBlock!!

newCollection add: anObject. ^newCollection

step 2. self new => aSortedCollection step 3. aSortedCollection sortBlock: aBlock! !

S.Ducasse

S.Ducasse

21

Instance Initialization

OrderedCollection with: 1

Collection class>>with: anObject "Answer a new instance of a Collection containing anObject."

SortedCollection class>>sortBlock: aBlock "Answer a new instance of SortedCollection such that its elements are sorted according to the criterion specified in aBlock." !

!"#$

!"#$

22

Providing a Default Value

How to ensure that an instance is well initialized?

OrderedCollection variableSubclass: #SortedCollection ! !

Automatic initialize Lazy initialization Proposing the right interface Providing a default value

instanceVariableNames: 'sortBlock ' classVariableNames: 'DefaultSortBlock '

SortedCollection class>>initialize !

DefaultSortBlock := [:x :y | x >initialize ! "Set the initial value of the receiver's sorting algorithm to a default.”

S.Ducasse

23

S.Ducasse

24

!"#$

Providing a Default Value

!"#$

Invoking per Default the Creation Interface !"#$

SortedCollection class>>new: anInteger ! "Answer a new instance of SortedCollection. The default sorting is a >new

! ! ! !

B class>>forceClientInterface

!

Packet class>>send: aString to: anAddress ! ^ self basicNew ! ! contents: aString ; ! ! addressee: anAddress

!

!

^ self basicNew doThatAndThatEnd

S.Ducasse

29

!"#$

30

Different Self/Super

But you cannot simply chain the calls...so use initialize

!"#$

Do not invoke a super with a different method selector.

A>>initialize super initialize.

It’s bad style because it links a class and a superclass.

self doThat; andThat; end

B>>initialize

It makes the code difficult to understand

super initialize. self andFoo.

S.Ducasse

^ super new doThatAndThatEnd

B class>>forceClientInterface !

!

^ self doThat; andThat; end

A class>>new

Conclusion: Never override basic* methods else you will not be able to invoke them later

Even Better...Use initialize

^ self basicNew ???

Solution: Define the initialization behavior on the instance side A>>doThatAndThatEnd !

S.Ducasse

^ super new doThat; andThat; end

This is dangerous in case the software evolves.

31

S.Ducasse

32

Example

!"#$

Packet class>>new self error: 'Packet should be created using send:to:' ! Packet class>>send: aString to: anAddress ! ^ super new contents: aString ; addressee: anAddress Use basicNew and basicNew:

S.Ducasse

33

Super is static!

!"#$

With the super foo: A foo bar

^ 10 ^ self foo

B foo bar

^ 100 ^ super foo

C foo

S.Ducasse

^ 50

A new bar -> 10 B new bar -> 10 C new bar -> 10

Without the super foo: A new bar -> 10 B new bar -> 100 C new bar 34