Principles Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Invariant Avoidance Principle (IAP) ======

===== Variants and Alternative Names =====


===== Context =====
/* fill in contexts here: */
  * [[contexts:Object-Oriented Design]]

===== Principle Statement =====

Avoid Invariants and Preconditions.


===== Description =====

Methods typically have preconditions. Something that has to be true prior to invoking the method so it can work properly. Typical cases are parameters that may not be ''null'' or have to be in a certain range. A solution is better the fewer preconditions there are.

Furthermore there are (class) invariants, i.e. conditions that have to be true in all observable states during the whole lifetime of an object. Typical invariants are attributes that may not be ''null'' or have to be in a certain range, lists that have to contain certain objects with certain properties, etc. A solution is better the fewer invariants there are.

While preconditions and invariants are absolutely necessary, introducing further ones comes at a certain cost.

Not that this principle does not apply to loop invariants, control-flow invariants, etc. as there is normally no chance to avoid them. But there can be fewer or more class invariants depending on the solution.


===== Rationale =====

A typical kind of defect is the violation of an invariant or a precondition. The more preconditions and invariants there are, the more possibilities there are to introduce defects. And according to [[Murphy's Law]] these possibilities will sooner or later result in defects. So it is better to avoid preconditions and invariants as this reduces the number of potential faults in the software.


===== Strategies =====

  * If the language supports that, use references which cannot be ''null''
    * In C++ use references instead of pointers (see [[#example 3: C++ references]])
    * In Java use primitive types instead of their object wrappers (''int'' instead of ''Integer'' but not ''int'' instead of ''Customer'')
  * Use [[patterns:value objects]] instead of primitive types (see [[#example 2: string preconditions]])
  * Avoid duplication of information. If the same information is stored in different places (maybe in different formats), the values may get out of sync (see also [[Don't repeat Yourself|DRY]]). This also applies to caching.


===== Caveats =====

Keep in mind that preconditions and invariants are absolutely necessary for every software. So this principle is constantly violated. Introducing preconditions and invariants is often also done deliberately in order to simplify the code (see [[Keep It Simple Stupid|KISS]]). So the purpose of this principle is mainly to point out that there are drawbacks. By no means invariants are problematic themselves or should be entirely avoided. They just also have disadvantages.

See also section [[#contrary principles]].


===== Origin =====

{{page>resources:A Principle Language for Object-Oriented Design#reference}}


===== Evidence =====
/* Comment out what is not applicable and explain the rest: */

  * [[wiki:Proposed]]

/*
  * [[wiki:Examined]]
  * [[wiki:Accepted]]
  * [[wiki:Questioned]]
*/

===== Relations to Other Principles =====

==== Generalizations ====

  * [[Murphy's Law]] (ML): ML states that an invariant will eventually be broken. So IAP is the application of ML to invariants.

==== Specializations ====

==== Contrary Principles ====

  * **[[Keep It Simple Stupid]] (KISS)**: Adding an invariant typically makes the code easier, as it can be assumed that the invariant holds. In fact that is often the very purpose if introducing invariants: Either they make the design easier or they are inevitable. Otherwise they should be avoided.

==== Complementary Principles ====

  * [[Information Hiding/Encapsulation]] (IH/E): When an invariant cannot be avoided, it should at least be encapsulated.
  * [[Liskov Substitution Principle]] (LSP): Not only the pure number and strength of invariants is relevant. The question is also which types in an inheritance hierarchy should have which invariants. Deriving ''Square'' from ''Rectangle'' for example adds an invariant in the subclass. LSP adds another point of view to this problem (see also [[glossary:rectangle-square problem]]).
  * [[Fail Fast]] (FF): Breaking an invariant is a defect. And in such a case the software should fail fast.
  * [[Don't Repeat Yourself]] (DRY): Duplication of information, like having the same data in different representations or like caching values, creates invariants. So an invariant sometimes is a hidden DRY violation.
  * [[Low Coupling]] (LC): One type of precondition is that a specific method has to be called prior to another one. This also results in a temporal coupling.

==== Principle Collections ====

{{page>collections:OOD Principle Language#Box}}


===== Examples =====

==== Example 1: Index Preconditions ====

<code java>
public void prettyPrintItem(List<Item> items, int index)
{
  ...
}
</code>

This method has the following preconditions:
  * ''items'' may not be ''null''
  * ''index'' must be greater or equal ''0''
  * ''index'' must be lesser than ''items.size()''

Compare the following solution:

<code java>
public void prettyPrintItem(Item item)
{
  ...
}
</code>

This is better as it just has one precondition: ''item'' may not be ''null''


==== Example 2: String Preconditions ====

<code java>
public void downloadFile(String url)
{
  ...
}
</code>

This method has the following preconditions:
  * ''url'' may not be ''null''
  * ''url'' must contain a valid URL (which is even a quite complicated precondition)

Compare the following method:

<code java>
public void downloadFile(URL url)
{
  ...
}
</code>

This is better since there is only one precondition: ''url'' may not be ''null''

==== Example 3: C++ References ====

Compare the following two methods:

<code c++>
void prettyPrint(SomeClass * obj)
{
  ...
}
</code>

<code c++>
void prettyPrint(SomeClass& obj)
{
  ...
}
</code>

In the second version ''obj'' cannot be ''NULL'' as it is a reference and not a pointer. So there is one precondition less.


==== Example 4: DRY ====

A class for [[wp>complex numbers]] should either store the real and the imaginary part or absolute value and argument but not both. If both are stored, there is the invariant that both representations result in the same complex number.

So it is better to store just one representation (e.g. the real and imaginary values) and if the other representation is needed (in this case the polar form), it can be computed. This can also be done transparently in the getter method.


==== Example 5: Caching ====

All forms of caching and redundancy are typical violations of IAP. They are done in order to increase performance. But there is always the disadvantage that all copies have to be kept in sync as there is the invariant that the data may not be inconsistent throughout the copies. There are forms of caching where temporary inconsistencies are tolerated. This is slightly better in terms of IAP but nevertheless there are these consistency constraints and there is the danger of violating them, so to some degree the disadvantage is always there.


===== Description Status =====
/* Choose one of the following and comment out the rest: */
/*[[wiki:Stub]]*/
/*[[wiki:Incomplete]]*/
[[wiki:Complete]]

===== Further Reading =====

  * {{page>resources:A Principle Language for Object-Oriented Design#reference}}

===== Discussion =====

Discuss this wiki article and the principle on the corresponding [[talk:principles:Invariant Avoidance Principle|talk page]].